Retrieve a list of all Customer-Profiles for an account.

GET /v1/CustomerProfiles

Retrieve a list of all Customer-Profiles for an account.

Query parameters

  • Status string

    The verification status of the Customer-Profile resource.

    Values are draft, pending-review, in-review, twilio-rejected, or twilio-approved.

  • FriendlyName string

    The string that you assigned to describe the resource.

  • PolicySid string

    The unique string of a policy that is associated to the Customer-Profile resource.

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

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

        The unique string that we created to identify the Customer-Profile resource.

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

      • account_sid string | null

        The SID of the Account that created the Customer-Profile resource.

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

      • policy_sid string | null

        The unique string of a policy that is associated to the Customer-Profile resource.

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

      • friendly_name string | null

        The string that you assigned to describe the resource.

      • status string

        The verification status of the Customer-Profile resource.

        Values are draft, pending-review, in-review, twilio-rejected, or twilio-approved.

      • valid_until string(date-time) | null

        The date and time in GMT in ISO 8601 format when the resource will be valid until.

      • email string | null

        The email address that will receive updates when the Customer-Profile resource changes status.

      • status_callback string(uri) | null

        The URL we call to inform your application of status changes.

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

      • url string(uri) | null

        The absolute URL of the Customer-Profile resource.

      • errors array | null

        The error codes associated with the rejection of the Customer-Profile.

    • 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/CustomerProfiles
curl \
 --request GET 'https://trusthub.twilio.com/v1/CustomerProfiles' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "results",
    "url": "https://trusthub.twilio.com/v1/CustomerProfiles?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "results": []
}
{
  "meta": {
    "key": "results",
    "url": "https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "results": [
    {
      "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "email": "email",
      "links": {
        "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations",
        "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments",
        "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments"
      },
      "errors": [
        {
          "code": 18601
        }
      ],
      "status": "twilio-approved",
      "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "valid_until": "2020-07-31T01:00:00Z",
      "date_created": "2019-07-30T22:29:24Z",
      "date_updated": "2019-07-31T01:09:00Z",
      "friendly_name": "friendly_name",
      "status_callback": "http://www.example.com"
    }
  ]
}