List user binding

GET /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings

List of bindings for a given user

Path parameters

  • ServiceSid string Required

    The SID of the Service to read the User Binding resources from.

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

  • UserSid string Required

    The SID of the User with the User Binding resources to read. See push notification configuration for more info.

Query parameters

  • BindingType array[string]

    The push technology used by the User Binding resources to read. Can be: apn, gcm, or fcm. See push notification configuration for more info.

    Values are gcm, apn, or fcm.

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

        The unique string that we created to identify the User Binding resource.

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

      • account_sid string | null

        The SID of the Account that created the User Binding 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 Service the User Binding resource is associated with.

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

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

      • endpoint string | null

        The unique endpoint identifier for the User Binding. The format of the value depends on the binding_type.

      • identity string | null

        The application-defined string that uniquely identifies the resource's User within the Service. See access tokens for more info.

      • user_sid string | null

        The SID of the User with the User Binding resource. See push notification configuration for more info.

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

      • credential_sid string | null

        The SID of the Credential for the binding. See push notification configuration for more info.

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

      • binding_type string

        The push technology to use for the User Binding. Can be: apn, gcm, or fcm. See push notification configuration for more info.

        Values are gcm, apn, or fcm.

      • message_types array[string] | null

        The Programmable Chat message types the binding is subscribed to.

      • url string(uri) | null

        The absolute URL of the User Binding resource.

    • 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 /v2/Services/{ServiceSid}/Users/{UserSid}/Bindings
curl \
 --request GET 'https://chat.twilio.com/v2/Services/{ServiceSid}/Users/{UserSid}/Bindings' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "bindings",
    "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "bindings": [
    {
      "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "endpoint": "TestUser-endpoint",
      "identity": "TestUser",
      "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "binding_type": "gcm",
      "date_created": "2016-10-21T11:37:03Z",
      "date_updated": "2016-10-21T11:37:03Z",
      "message_types": [
        "removed_from_channel",
        "new_message",
        "added_to_channel",
        "invited_to_channel"
      ],
      "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}
{
  "meta": {
    "key": "bindings",
    "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "bindings": []
}