Retrieve Role (since 1.0.12)
CUSTOM-ENDPOINT
GET https://api.speakap.io/networks/:eid/roles/:role/
CUSTOM-REQUEST
- URI: /networks/{networkEID}/roles/{role}/
- Method: GET
- Accept: application/vnd.speakap.api-v1.8.2+json+hal
- Authentication: OAuth 2.0
Parameters
| Name | Type | Description | |
|---|---|---|---|
| networkEID | EID | Network EID | |
| role | string | EID | Key of a built-in role (e.g., default or admin) or the EID of a user-defined role |
Response
| Status | Data |
|---|---|
| 200 | Returns a Role resource |
| 403 | Unauthorized: returns an Error object |
| 404 | Unknown network: returns an Error object |