Get an Access Role
GET
/api/v2/roles/{id}.json
Retrieve a single Access Role using its ID.
Scopes
Requires either the roles or roles.readonly OAuth scope.
Parameters
Accepts the following parameters:
id
required
The ID of the Access Role is supplied as a path parameter. |
Response
Returns an object with the following properties:
success
A boolean where a value of true represents a successful request.
|
status
The HTTP status code e.g. 200 for a successful request.
|
data
Contains the Access Role object. |
JSON Example
An example of JSON returned.
{
"success": true,
"status": 200,
"data": {
"id": 53245,
"reference": "trade-account",
"title": "Trade Account",
"deniedUrl": null,
"approvalMethod": "admin",
"emailValidationUrl": null,
"adminPendingUrl": null,
"adminApprovedUrl": null,
"adminRejectedUrl": null,
"adminApprovalEmail": "administrator@example.com",
"createdOn": "2022-05-21T15:54:05+00:00",
"modifiedOn": "2022-05-21T15:54:05+00:00"
}
}