List service

GET /v1/Services

Query parameters

  • FriendlyName string

    The string that identifies the Service resources to read.

  • PageSize integer(int64)

    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.

  • 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
    • services array[object]
      Hide services attributes Show services attributes object
      • sid string | null

        The unique string that we created to identify the Service resource.

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

      • account_sid string | null

        The SID of the Account that created the Service resource.

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

      • friendly_name string | null

        The string that you assigned to describe the resource.

      • date_created string(date-time) | null

        The date and time in GMT when the resource was created specified in RFC 2822 format.

      • date_updated string(date-time) | null

        The date and time in GMT when the resource was last updated specified in RFC 2822 format.

      • apn_credential_sid string | null

        The SID of the Credential to use for APN Bindings.

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

      • gcm_credential_sid string | null

        The SID of the Credential to use for GCM Bindings.

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

      • fcm_credential_sid string | null

        The SID of the Credential to use for FCM Bindings.

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

      • messaging_service_sid string | null

        The SID of the Messaging Service to use for SMS Bindings. In order to send SMS notifications this parameter has to be set.

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

      • facebook_messenger_page_id string | null

        Deprecated.

      • default_apn_notification_protocol_version string | null

        The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.

      • default_gcm_notification_protocol_version string | null

        The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.

      • default_fcm_notification_protocol_version string | null

        The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.

      • log_enabled boolean | null

        Whether to log notifications. Can be: true or false and the default is true.

      • url string(uri) | null

        The absolute URL of the Service resource.

      • alexa_skill_id string | null

        Deprecated.

      • default_alexa_notification_protocol_version string | null

        Deprecated.

      • delivery_callback_url string | null

        URL to send delivery status callback.

      • delivery_callback_enabled boolean | null

        Callback configuration that enables delivery callbacks, default false

    • 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
curl \
 --request GET 'https://notify.twilio.com/v1/Services' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "services",
    "url": "https://notify.twilio.com/v1/Services?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://notify.twilio.com/v1/Services?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "services": [
    {
      "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "type": "S",
      "links": {
        "users": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users",
        "bindings": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings",
        "segments": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Segments",
        "notifications": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications"
      },
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "log_enabled": true,
      "date_created": "2016-03-09T20:22:31Z",
      "date_updated": "2016-03-09T20:22:31Z",
      "friendly_name": "733c7f0f-6541-42ec-84ce-e2ae1cac588c",
      "alexa_skill_id": null,
      "apn_credential_sid": null,
      "fcm_credential_sid": null,
      "gcm_credential_sid": null,
      "delivery_callback_url": "Hello",
      "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "delivery_callback_enabled": true,
      "facebook_messenger_page_id": "4",
      "default_apn_notification_protocol_version": "3",
      "default_fcm_notification_protocol_version": "3",
      "default_gcm_notification_protocol_version": "3",
      "default_alexa_notification_protocol_version": "3"
    }
  ]
}
{
  "meta": {
    "key": "services",
    "url": "https://notify.twilio.com/v1/Services?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://notify.twilio.com/v1/Services?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "services": []
}