/v1/events

get

https://api.apptoto.com/v1/events

Fetch a range of "events".

Please note that you can also use this API to fetch one event by id or external_id (for legacy reasons). The new proper way to fetch one event is to use the /v1/event (singular) API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

begin

date

Only events starting at or after this date/time will be included. (ISO8601)

end

date

Only events starting at or before this Date/Time will be included. (ISO8601)

phone_number

string

Only events who have a participant with the given phone number will be included. The phone number will be normalized based on the Apptoto user's default country setting. If the phone number you are filtering on is in a different country then include the fully normalized phone number (e.g. +66234234234).

email_address

string

Only events who have a participant with the specified email address will be incluced

page_size

int32

Defaults to 30

The number of events to return

page

int32

Defaults to 1

The page to fetch (1 based)

include_deleted

boolean

Defaults to false

Include deleted events

include_conversations

boolean

Defaults to false

If true, then Apptoto will include any conversations sent about the event. The conversations will be an array on each participant with the key "conversations".

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here!