RELAY RESTCampaign Registry

List all Campaigns

View as Markdown

Returns a list of campaigns for a brand.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the brand.

Query parameters

filter_namestringOptional
The name given to the campaign. Will return all Campaigns containing this value as a substring.
filter_statestringOptional
The state of the campaign in the registration process, such as pending or complete. Will return all campaigns with this value.

Response

The request has succeeded.
datalist of objects or null
List of campaigns.

Errors