Skip to main content
GET
Retrieve campaigns

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

channel
string

Filter by channel. Comma-separated, one or more of: email, push.

id
string

IDs of the campaigns to get, up to 25. The campaigns found are returned on one page, newest first. Comma-separated, one or more UUIDs.

limit
integer

Maximum number of campaigns per page. Defaults to 25.

Required range: 1 <= x <= 100
locationRef
string<uuid>

ID of a location whose campaigns to list: those whose audience includes it. Lists the campaigns of every location when omitted.

nextPageToken
string

Token of the page to read next.

status
string

Filter by stage. Comma-separated, one or more of: draft, scheduled, sending, sent, canceled, failed.

Response

OK

campaigns
object[]
required

List of campaigns, newest first.

nextPageToken
string

Pagination token to fetch the next page of results.

searchQueryNext
string

Search query parameters for the next page of results. Includes all filters used to fetch the current page.