Skip to main content

List all Phone Number Assignments

Returns a list of the phone number assignments for a campaign. The numbers 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.

Path Parameters
id uuid REQUIRED

Unique ID of the campaign

Query Parameters
filter_state string

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

Responses
200

OK

Schema OPTIONAL
links object OPTIONAL
self string OPTIONAL
first string OPTIONAL
next string OPTIONAL
prev string OPTIONAL
data object[] OPTIONAL
id uuid

The unique id of the assignment.

state string OPTIONAL

The current state of the assignment.

campaign_id uuid OPTIONAL
phone_number object OPTIONAL
id uuid OPTIONAL
name string OPTIONAL
number string OPTIONAL
created_at date-time OPTIONAL
updated_at date-time OPTIONAL