Skip to main content

List all Campaigns

GET 

/registry/beta/brands/:id/campaigns

Returns a list of the campaigns for a brand. The campaigns are returned sorted by creation date, with the most recent appearing first. The list is filterable by sending in any of the following parameters.

Permissions

The API token must include the following scopes: Messaging.

Request

Path Parameters

    id uuidrequired

    Unique ID of the brand

Query Parameters

    filter_name string

    The name given to the campaign. Will return all Campaigns containing this value as a substring.

    filter_state string

    The state of the campaign in the registration process, such as pending or complete. Will return all campaigns with this value.

Responses

OK

Schema

    links

    object

    self string
    first string
    next string
    prev string
    data object[]
Loading...