Retrieve Role (since 1.0.12)

GET https://api.speakap.io/networks/:eid/roles/:role/

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

200
Returns a Role resource
403
Unauthorized: returns an Error object
404
Unknown role: returns an Error object