List Event Chains

get

https://{api_url}/api/v5/admin/{company_id}/event_chains

Retrieves a list of event chains.
Event chains are either single events, regularly occurring events or are courses.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

string

required

Company ID

Query Params

member_level_id

int32

Ask for pricing for the event targeted to a specific membership level

start_date

date

end_date

date

modified_since

string

Only include event chains modified after this datetime. Format YYYY-MM-DDTHH:mm:ss

created_after

string

Only include event chains created after this datetime. Format YYYY-MM-DDTHH:mm:ss

created_before

string

Only include event chains created until this datetime. Format YYYY-MM-DDTHH:mm:ss

event_group_id

int32

An event group

global_event_group_id

int32

The global ID of An event group

page

int32

Defaults to 1

per_page

int32

Defaults to 100

include_disabled

boolean

Include disabled event chains

include_deleted

boolean

Include deleted event chains

only_disabled

boolean

Only disabled events

event_type

string

enum

Filter by event type

Allowed:

order_by[name]

string

enum

Allowed:

order_by[start_date]

string

enum

Allowed:

order_by[created_at]

string

enum

Allowed:

filter_by[custom_fields_and_answers]

array of strings

Business questions and answers

filter_by[custom_fields_and_answers]

filter_by[custom_fields_and_answers][answer]

array of strings

Answer to a specific business question

filter_by[custom_fields_and_answers][answer]

filter_by[custom_fields_and_answers][custom_field_id]

array of int32s

Business question id

filter_by[custom_fields_and_answers][custom_field_id]

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Event Chain Collection