Retrieve a list of all Permissions applying to a Sync Document

GET /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions

Sync document permissions

Retrieve a list of all Permissions applying to a Sync Document.

Path parameters

  • ServiceSid string Required

    The SID of the Sync Service with the Document Permission resources to read.

  • DocumentSid string Required

    The SID of the Sync Document with the Document Permission resources to read. Can be the Document resource's sid or its unique_name.

Query parameters

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • meta object
      Hide meta attributes Show meta attributes
    • permissions array[object]
      Hide permissions attributes Show permissions attributes
      • account_sid string | null

        The SID of the Account that created the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • document_sid string | null

        The Sync Document SID

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^ET[0-9a-fA-F]{32}$.

      • identity string | null

        The identity of the user to whom the Sync Document Permission applies

      • manage boolean | null

        Manage access

      • read boolean | null

        Read access

      • service_sid string | null

        The SID of the Sync Service that the resource is associated with

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

      • url string(uri) | null

        The absolute URL of the Sync Document Permission resource

      • write boolean | null

        Write access
GET /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions 
curl \
 -X GET https://sync.twilio.com/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "permissions": [
    {
      "account_sid": "string",
      "document_sid": "string",
      "identity": "string",
      "manage": true,
      "read": true,
      "service_sid": "string",
      "url": "https://example.com",
      "write": true
    }
  ]
}