Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-0510371832.3 KB
ConversationsV1Role

Fetch a user role from your service

Fetch a user role from your service

get/v1/Services/{ChatServiceSid}/Roles/{Sid}

Path parameters

ChatServiceSidstring required

The SID of the Conversation Service to fetch the Role resource from.

Sidstring required

The SID of the Role resource to fetch.

Response

OK

sidstring nullable

The unique string that we created to identify the Role resource.

account_sidstring nullable

The SID of the Account that created the Role resource.

chat_service_sidstring nullable

The SID of the Conversation Service the Role resource is associated with.

friendly_namestring nullable

The string that you assigned to describe the resource.

type'conversation' | 'service'

The type of role. Can be: conversation for Conversation roles or service for Conversation Service roles.

permissionsstring[] nullable

An array of the permissions the role has been granted.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlstring uri nullable

An absolute API resource URL for this user role.