Compatibility REST APIApplications

List Applications

View as Markdown
The ability to read all of the applications that are associated with your Account. This will be returned as a list of applications. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

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

AccountSidstringRequiredformat: "uuid"
The Account ID that has the Application.

Query parameters

FriendlyNamestringOptional
Filter by a named unique identifier for the resource.
PageintegerOptional>=0Defaults to 0

The page number to retrieve. Page numbers are zero-indexed, so the first page is 0.

PageSizeintegerOptional1-1000Defaults to 50
The number of results to return per page. The default is 50, and the maximum is 1000.
PageTokenstringOptional
A token used to retrieve a specific page of results.

Response

The request has succeeded.
uristring
The URI for this resource.
first_page_uristring
The URI for the first page of results.
next_page_uristring or null
The URI for the next page of results. Null if there are no more pages.
previous_page_uristring or null
The URI for the previous page of results. Null if this is the first page.
pageinteger

The current page number. Zero-indexed.

page_sizeinteger
The number of results per page.
applicationslist of objects
List of applications.

Errors