List campaigns

get

https://api.sintalk.com.br/v3/campaigns

Returns your campaigns newest first, ordered by created_at descending.

Array-valued filters (channel, status, template_id) are repeatable query parameters (e.g. status=draft&status=running): values are OR-combined within a dimension and AND-combined across dimensions; each also accepts a single value.

Query Params

channel

array of objects

Keep only campaigns sending over one of these channels.

channel

Allowed:

status

array of objects

Keep only campaigns currently in one of these lifecycle states.

status

Allowed:

template_id

array of uuids

length between 0 and 100

Keep only campaigns sending one of these templates; up to 100 ids.

template_id

string

length between 3 and 120

Case-insensitive substring filter on the campaign name; minimum 3 characters.

created_from

date-time

Keep only campaigns whose created_at is at or after this instant.

created_to

date-time

Keep only campaigns whose created_at is at or before this instant.

limit

int32

1 to 1000

Defaults to 25

Page size; defaults to 25, max 1000 (larger values are rejected).

offset

int32

≥ 0

Rows to skip before this page; defaults to 0.

Responses

Language

Credentials

Loading…

Response

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

application/json

200A page of campaigns, newest first.

400The request was rejected before it was applied — either a field failed validation (validation_failed, with error.fields naming each one), or the request could not be read at all (bad_request: malformed JSON, an unknown field, a missing parameter, or an unparseable path or query value).

401No credential was presented, or the one presented was rejected.

403The credential is valid but is not allowed to call this operation.

429Rate limit exceeded

defaultAn unexpected error. Safe to retry with backoff; use an idempotency key where the operation accepts one.