Get resource associations
Get a paginated list of resource associations.
Authorizations:
Scopes:
Request rate limit:
query Parameters
page | integer <int32> >= 0 Default: 0 Results page to retrieve (0..N). |
size | integer <int32> [ 1 .. 1000 ] Default: 20 Number of records per page. |
resourceType | string Enum: "NUMBER" "DOMAIN" "ALPHA" The type of resource to be used. |
channel | string Enum: "SMS" "MMS" "EMAIL" The channel for which the resource will be used. |
applicationId | string <= 255 characters Example: applicationId=test-application The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints. |
entityId | string <= 255 characters Example: entityId=test-entity The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints. |
resourceId | string <= 255 characters Example: resourceId=test-resource The unique identifier of the resource. It depends on both the |
Responses
OK
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
Request samples
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
curl -L -g 'https://{baseUrl}/provisioning/1/associations?applicationId=test-application&entityId=test-entity&resourceId=test-resource' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json'
Response samples
- 200
- 401
- 403
- 429
- 500
{- "results": [
- {
- "resourceType": "NUMBER",
- "channel": "SMS",
- "applicationId": "test-application",
- "entityId": "test-entity",
- "resourceId": "test-resource"
}
], - "paging": {
- "page": 0,
- "size": 1,
- "totalPages": 0,
- "totalResults": 0
}
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See