Fetch sync list

GET /v1/Services/{ServiceSid}/Lists/{Sid}

Sync list objects

Path parameters

  • ServiceSid string Required

    The SID of the Sync Service with the Sync List resource to fetch.

  • Sid string Required

    The SID of the Sync List resource to fetch. Can be the Sync List resource's sid or its unique_name.

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
    • sid string | null

      The unique string that we created to identify the Sync List resource.

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

    • unique_name string | null

      An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.

    • account_sid string | null

      The SID of the Account that created the Sync List 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}$.

    • url string(uri) | null

      The absolute URL of the Sync List resource.

    • revision string | null

      The current revision of the Sync List, represented as a string.

    • date_expires string(date-time) | null

      The date and time in GMT when the Sync List expires and will be deleted, specified in ISO 8601 format. If the Sync List does not expire, this value is null. The Sync List might not be deleted immediately after it expires.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • created_by string | null

      The identity of the Sync List's creator. If the Sync List is created from the client SDK, the value matches the Access Token's identity field. If the Sync List was created from the REST API, the value is system.

GET /v1/Services/{ServiceSid}/Lists/{Sid}
curl \
 --request GET 'https://sync.twilio.com/v1/Services/{ServiceSid}/Lists/{Sid}' \
 --user "username:password"
Response examples (200)
{
  "sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items",
    "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions"
  },
  "revision": "revision",
  "created_by": "created_by",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "unique_name": "unique_name",
  "date_created": "2015-07-30T20:00:00Z",
  "date_expires": "2015-07-30T21:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z"
}