The GET /users/{userId}/permissions/addresses endpoint gets a list of all address permissions for the user matching the user ID provided.
In this page
Parameters
The endpoint accepts the following query parameters:
userID
Type | Required | Example |
|---|---|---|
| String | True | 2f9207ca-8922-4245-bfc5-d8f42939e29a |
The user ID of the required user.
limit
Type | Required | Example |
|---|---|---|
| integer | False | 25 |
The required number of items per page. Minimum of 1. Maximum of 5000. Default is 25.
page
Type | Required | Example |
|---|---|---|
| integer | False | 1 |
The required page. Minimum of 1, maximum of 1000000000. Default is 1.
Responses
Responses contain a list of all address permissions for the user matching the user ID provided.
Successful response
Successful requests return a 200 Success code and a collection of address permissions.
Example response
{
"meta": {
"page": 1,
"count": 1,
"pageCount": 1,
"totalCount": 1
},
"userId": "c7705a71-dac7-411f-8a7a-d1c6473334cc",
"addressPermissions": [
{
"addressId": "441259236129",
"addressName": "Main line"
}
]
}
where:
userId. The unique ID of the user.addressPermissions. The user’s address permissions.addressId. The unique ID of the address that the user has access to.addressName. The name of the address that the user has access to.