List phone number assignment orders

View as MarkdownOpen in Claude

Returns a list of orders for a campaign.

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 campaign.

Query parameters

filter_statestringOptional
The state of the orders in the registration process, such as pending or processed. Will return all orders with this value.

Response

The request has succeeded.
datalist of objects
List of orders.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error