Search Submitted Events

Search events submitted by your organization.

For example, you can use this to display a list of events submitted via Loop Links within your application to your users. See also the Events API documentation for more detail on many of the parameters mentioned below.

Search Submitted Events

get

Authorizations

BearerAuth

AuthorizationstringRequired

Enter your PredictHQ API key. The Bearer prefix is added automatically.

When calling the API directly, send: Authorization: Bearer <YOUR_API_KEY> as documented at https://docs.predicthq.com/api/overview/authenticating

Query parameters

qstringOptional

Full-text search of event information.

E.g. ?q=hotel+a

link_idstring[]Optional

Comma-separated list of link ids. Allows you to filter for events submitted via a specific Loop Link ID.

E.g. ?link_id=m4Dk4g4DRA8Yqbp2PC54

event_idstring[]Optional

Comma-separated list of event IDs. Allows you to retrieve specific events.

E.g. ?event_id=5uRg7CqGu7DTtu4Rfk

user_idstring[]Optional

Comma-separated list of user IDs that submitted the event.

E.g. ?user_id=hw8Dsmv4Djg

categorystring[]Optional

Comma separated list of event categories.

E.g. ?category=expos,festivals

labelstring[]Optional

Comma separated list of event labels.

E.g. ?label=community,food,music

countrystring[]Optional

Comma separated list of country codes.

E.g. ?country=NZ,US

start.ltstring · dateOptional

The date of the event start: less than.

E.g. ?start.lt=2023-03-04

start.ltestring · dateOptional

The date of the event start: less than or equal to.

E.g. ?start.lte=2023-03-04

start.gtstring · dateOptional

The date of the event start: greater than.

E.g. ?start.gt=2023-03-04

start.gtestring · dateOptional

The date of the event start: greater than or equal to.

E.g. ?start.gte=2023-03-04

end.ltstring · dateOptional

The date of the event end: less than.

E.g. ?start.lt=2023-03-04

end.ltestring · dateOptional

The date of the event end: less than or equal to.

E.g. ?end.lte=2023-03-04

end.gtstring · dateOptional

The date of the event end: greater than.

E.g. ?end.gt=2023-03-04

end.gtestring · dateOptional

The date of the event end: greater than or equal to.

E.g. ?end.gte=2023-03-04

active.ltstring · dateOptional

The date the event is active: less than.

E.g. ?active.lt=2023-03-04

active.ltestring · dateOptional

The date the event is active: less than or equal to.

E.g. ?active.lte=2023-03-04

active.gtstring · dateOptional

The date the event is active: greater than.

E.g. ?active.gt=2023-03-04

active.gtestring · dateOptional

The date the event is active: greater than or equal to.

E.g. ?active.gte=2023-03-04

created.ltstring · dateOptional

The date when the event was created: less than.

E.g. ?created.lt=2023-03-04

created.ltestring · dateOptional

The date when the event was created: less than or equal to.

E.g. ?created.lte=2023-03-04

created.gtstring · dateOptional

The date when the event was created: greater than.

E.g. ?created.gt=2023-03-04

created.gtestring · dateOptional

The date when the event was created: greater than or equal to.

E.g. ?created.gte=2023-03-04

updated.ltstring · dateOptional

The date to the event was last updated: less than.

E.g. ?updated.lt=2023-03-04

updated.ltestring · dateOptional

The date when the event was last updated: less than or equal to.

E.g. ?updated.lte=2023-03-04

updated.gtstring · dateOptional

The date when the event was last updated: greater than.

E.g. ?updated.gt=2023-03-04

updated.gtestring · dateOptional

The date when the event was last updated: greater than or equal to.

E.g. ?updated.gte=2023-03-04

private.includestring · enumOptional

Whether or not to include private events. Rejected & pending events will always be private. Possible values:

• true: private and public events
• false: only public events
• only: only private events

E.g ?private.include=only

Default: falsePossible values:

org_reviewstring · enumOptional

Filter for submitted events approved, rejected or yet to be reviewed by the your Org. Possible values:

• pending
• approved
• rejected

E.g ?org_review=approved

Possible values:

phq_reviewstring · enumOptional

Filter for submitted events approved, rejected or yet to be reviewed by PredictHQ. Possible values:

• pending
• approved
• rejected

E.g ?phq_review=approved

Possible values:

limitintegerOptional

Limit the number of results.

Default: 10

offsetintegerOptional

Offset the results.

Default: 0

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/loop/events

HTTPcURLJavaScriptPython

GET /v1/loop/events HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "events": [
    {
      "event_id": "text",
      "link_id": "text",
      "create_dt": "text",
      "update_dt": "text",
      "version": 1,
      "phq_review": "pending",
      "org_review": "pending",
      "phq_auto_approved": true,
      "event": {
        "title": "text",
        "description": "text",
        "category": [
          "academic"
        ],
        "state": [
          "active"
        ],
        "metadata": [
          {
            "attendance": {
              "count": 1
            },
            "maximum_attendance": 1,
            "estimated_fatalities": {
              "count": 1
            },
            "estimated_injuries": {
              "count": 1
            }
          }
        ],
        "dates": {
          "floating_date": {
            "start_date": "2026-01-29",
            "end_date": "2026-01-29"
          },
          "floating_time": {
            "start_local_datetime": "text",
            "end_local_datetime": "text"
          },
          "fixed_date": {
            "start_date": "2026-01-29",
            "end_date": "2026-01-29",
            "timezone": "text"
          },
          "fixed_time": {
            "start_timestamp": "2026-01-29T01:18:10.282Z",
            "end_timestamp": "2026-01-29T01:18:10.282Z",
            "start_local_datetime": "text",
            "end_local_datetime": "text",
            "timezone": "text"
          }
        },
        "labels": [
          "text"
        ],
        "lat": "38.901544",
        "lon": "-119.7030036",
        "address": "text",
        "formatted_address": "text",
        "city": "text",
        "region": "text",
        "postcode": "text",
        "country": "text",
        "geometry": {
          "type": "text",
          "coordinates": [
            174.776792,
            -36.847319
          ]
        }
      }
    }
  ]
}

OpenAPI Spec

The OpenAPI spec for Loop API can be found here.

Guides

ow are some guides relevant to this API:

• Integrate with Loop Links