Skip to main content

List all permission groups

GET 
/auth/permission_groups

Returns a list of your permission groups. Results are paginated to improve retrieval peformance. The meta data indicates how many total records exist.

Request

Query Parameters

    include_actions boolean

    If false, only ids will be returned, otherwise the nested resource will be returned.

    include_resource_groups boolean

    If false, only ids will be returned, otherwise the nested resource will be returned.

    page[number] double

    Current page based on pagination settings.

    page[size] double

    Number of results to return per page based on pagination settings.

Responses

200: Successful response

401: Authentication error

403: Authorization error

422: Invalid parameters supplied in request. See HTTP response body for details.

Request samples


curl -L 'https://api.telnyx.com/auth/permission_groups' \
-H 'Accept: application/json'

Response samples


{
"data": [
{
"id": "1490ecab-d4a1-4f22-abe7-60f5500a060f",
"description": "Text Jenny",
"actions": [
"string"
],
"resource_groups": [
"string"
],
"record_type": "permission_group",
"created_at": "2018-02-08T18:49:22.998023Z",
"updated_at": "2018-02-08T18:49:22.998023Z"
}
],
"meta": {
"total_pages": 13,
"total_results": 13,
"page_number": 3,
"page_size": 1
}
}