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

GET /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions
Account sid auth token

Permissions for Sync list items

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

Path parameters

  • ServiceSid string Required

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

  • ListSid string Required

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

Query parameters

  • PageSize integer(int64)

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

    Minimum value is 1, maximum value is 100.

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

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

        The SID of the Account that created the Sync List Permission resource.

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

      • service_sid string | null

        The SID of the Sync Service 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}$.

      • list_sid string | null

        The SID of the Sync List to which the Permission applies.

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

      • identity string | null

        The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.

      • read boolean | null

        Whether the identity can read the Sync List and its Items.

      • write boolean | null

        Whether the identity can create, update, and delete Items in the Sync List.

      • manage boolean | null

        Whether the identity can delete the Sync List.

      • url string(uri) | null

        The absolute URL of the Sync List Permission resource.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions 
curl \
 --request GET 'https://sync.twilio.com/v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions' \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "key": "permissions",
    "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "permissions": []
}
{
  "meta": {
    "key": "permissions",
    "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/sidOrUniqueName/Permissions?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "permissions": [
    {
      "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity",
      "read": true,
      "write": true,
      "manage": true,
      "identity": "identity",
      "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}