Fetch service

GET /v1/Services/{Sid}

Containers for sync objects

Path parameters

  • Sid string Required

    The SID of the Service resource to fetch.

Responses

  • OK

    Hide response attributes Show response attributes object
    • 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}$.

    • acl_enabled boolean | null

      Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • friendly_name string | null

      The string that you assigned to describe the resource

    • Whether every endpoint_disconnected event occurs after a configurable delay

    • The reachability event delay in milliseconds

    • Whether the service instance calls webhook_url when client endpoints connect to Sync

    • sid string | null

      The unique string that identifies the resource

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

    • unique_name string | null

      An application-defined string that uniquely identifies the resource

    • url string(uri) | null

      The absolute URL of the Service resource

    • webhook_url string(uri) | null

      The URL we call when Sync objects are manipulated

    • Whether the Service instance should call webhook_url when the REST API is used to update Sync objects

GET /v1/Services/{Sid}
curl \
 -X GET https://sync.twilio.com/v1/Services/{Sid} \
 --user "username:password"
Response examples (200)
{
  "account_sid": "string",
  "acl_enabled": true,
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "links": {},
  "reachability_debouncing_enabled": true,
  "reachability_debouncing_window": 42,
  "reachability_webhooks_enabled": true,
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com",
  "webhook_url": "https://example.com",
  "webhooks_from_rest_enabled": true
}
Response examples (200)
{
  "account_sid": "string",
  "acl_enabled": true,
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "links": {},
  "reachability_debouncing_enabled": true,
  "reachability_debouncing_window": 42,
  "reachability_webhooks_enabled": true,
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com",
  "webhook_url": "https://example.com",
  "webhooks_from_rest_enabled": true
}