List sync map item

GET /v1/Services/{ServiceSid}/Maps/{MapSid}/Items

Keys in a sync map

Path parameters

  • ServiceSid string Required

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

  • MapSid string Required

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

Query parameters

  • Order string

    How to order the Map Items returned by their key value. Can be: asc (ascending) or desc (descending) and the default is ascending. Map Items are ordered lexicographically by Item key.

    Values are asc or desc.

  • From string

    The key of the first Sync Map Item resource to read. See also bounds.

  • Bounds string

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

    Values are inclusive or exclusive.

  • 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
    • items array[object]
      Hide items attributes Show items 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}$.

      • created_by string | null

        The identity of the Map Item's creator

      • data

        An arbitrary, schema-less object that the Map Item stores

      • date_created string(date-time) | null

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

      • date_expires string(date-time) | null

        The ISO 8601 date and time in GMT when the Map Item expires

      • date_updated string(date-time) | null

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

      • key string | null

        The unique, user-defined key for the Map Item

      • map_sid string | null

        The SID of the Sync Map that contains the Map Item

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

      • revision string | null

        The current revision of the Map Item, represented as a string

      • 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 Map Item resource

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/Services/{ServiceSid}/Maps/{MapSid}/Items 
curl \
 -X GET https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{MapSid}/Items \
 --user "username:password"
Response examples (200) 
{
  "items": [
    {
      "account_sid": "string",
      "created_by": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_expires": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "key": "string",
      "map_sid": "string",
      "revision": "string",
      "service_sid": "string",
      "url": "https://example.com"
    }
  ],
  "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"
  }
}