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.
Request
Query Parameters
q
(string, optional)
q
(string, optional)Full-text search of event information. E.g. ?q=hotel+a
link_id
(string, optional)
link_id
(string, 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_id
(string, optional)
event_id
(string, optional)Comma-separated list of event IDs. Allows you to retrieve specific events. E.g. ?event_id=5uRg7CqGu7DTtu4Rfk
user_id
(string, optional)
user_id
(string, optional)Comma-separated list of user IDs that submitted the event. E.g. ?user_id=hw8Dsmv4Djg
state
(string, optional)
state
(string, optional)Comma separated list of event states. Possible values: active
, predicted
, cancelled
, postponed
, archived
.
category
(string, optional)
category
(string, optional)Comma separated list of event categories. E.g. ?category=expos,festivals
label
(string, optional)
label
(string, optional)Comma separated list of event labels. E.g. ?label=community,food,music
country
(string, optional)
country
(string, optional)Comma separated list of country codes. E.g. ?country=NZ,US
start.*
(string, optional)
start.*
(string, optional)The date from and/or to the event starts. Must be used with suffixes lt
, lte
, gt
or gte
.
E.g. ?start.gt=2023-03-04&start.lte=2023-05-01
end.*
(string, optional)
end.*
(string, optional)The date from and/or to the event ends. Must be used with suffixes lt
, lte
, gt
or gte
E.g. ?end.gt=2023-03-04&end.lte=2023-05-01
active.*
(string, optional)
active.*
(string, optional)The date from and/or to the event is active. Must be used with suffixes lt
, lte
, gt
or gte
.
E.g. ?active.gt=2023-03-04&active.lte=2023-05-01
created.*
(string, optional)
created.*
(string, optional)The date from and/or to the event has been created. Must be used with suffixes lt
, lte
, gt
or gte
.
E.g. ?created.gt=2023-03-04&created.lte=2023-05-01
updated.*
(string, optional)
updated.*
(string, optional)The date from and/or to the event was last updated. Must be used with suffixes lt
, lte
, gt
or gte
.
E.g. ?updated.gt=2023-03-04&updated.lte=2023-05-01
private.include
(string, optional, defaults to false
)
private.include
(string, optional, defaults to false
)Whether or not to include private events. Rejected & pending events will always be private. Possible values:
true
: private and public eventsfalse
only public eventsonly
: only private events
E.g ?private.include=only
org_review
(string, optional)
org_review
(string, optional)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
phq_review
(string, optional)
phq_review
(string, optional)Filter for submitted events approved, rejected or yet to be reviewed by PredictHQ. Possible values: pending
, approved
, rejected
. E.g ?phq_review=approved
sort
(string, optional, defaults torelevance,-updated
)
sort
(string, optional, defaults torelevance,-updated
)Comma-separated list of sort options. Prefix the field name with -
for reverse order (e.g., -created
). Possible values**:**
created
updated
version
relevance
E.g. ?sort=-updated
limit
(number, optional, defaults to10
)
limit
(number, optional, defaults to10
)The maximum number of results to return. E.g. ?limit=10
offset
(number, optional, defaults to 0
)
offset
(number, optional, defaults to 0
)The number of results to skip. E.g. ?offset=20
Response
Response Fields
Submitted Event Response Fields
Guides
Below are some guides relevant to this API:
Last updated