API Reference

List campaigns

get
https://campaign-api.omni.chat/v1/campaigns/

Retrieves the details of campaigns by paging the dataset, taking the limit, startDate, endDate and tokenPagination as query parameters. The campaigns will be returned sorted by createdAt in descending order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number

specifies the number of results to be returned from the call. If not specified, the default limit value is 100. The max limit value is also 100.

string

date formatted as ISO 8601 (YYYY-MM-DDTHH:mm:ss) where the query will start the search, by default the value is one week ago from the current date.

string

date formatted as ISO 8601 (YYYY-MM-DDTHH:mm:ss) where the search will end, by default the value is the current date.

string

used to get the next page, if null, the request will search by the beginning. For each request, the tokenPagination will be returned in the response.

string

Time zone used in dates, a list of time zones supported can be found here (https://timezonedb.com/time-zones) in the Time Zone column, by default the value is America/Sao_Paulo

Headers
string

the response by default is JSON, but you can request the response in CSV.

Responses

Updated 7 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago