Path parameters

• ServiceSid string Required

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

• ListSid string Required

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

Query parameters

• Order string

  How to order the List Items returned by their index value. Can be: asc (ascending) or desc (descending) and the default is ascending.

  Values are asc or desc.

• From string

  The index of the first Sync List Item resource to read. See also bounds.

• Bounds string

  Whether to include the List Item referenced by the from parameter. Can be: inclusive to include the List Item referenced by the from parameter or exclusive to start with the next List Item. The default value is inclusive.

  Values are inclusive or exclusive.

• 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

  • items array[object]
    Hide items attributes Show items attributes object

    • index integer

      The automatically generated index of the List Item. The index values of the List Items in a Sync List can have gaps in their sequence.

      Default value is 0.

    • account_sid string | null

      The SID of the Account that created the List Item 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 that contains the List Item.

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

    • url string(uri) | null

      The absolute URL of the List Item resource.

    • revision string | null

      The current revision of the item, represented as a string.

    • data object | null

      An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length.

    • date_expires string(date-time) | null

      The date and time in GMT when the List Item expires and will be deleted, specified in ISO 8601 format. If the List Item does not expire, this value is null. The List Item resource 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 List Item's creator. If the item is created from the client SDK, the value matches the Access Token's identity field. If the item was created from the REST API, the value is system.

  • 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)