Retrieve a list of all Customer-Profiles for an account

GET /v1/CustomerProfiles

TODO: Resource-level docs

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.

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

      • 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

      • email string | null

        The email address

      • friendly_name string | null

        The string that you assigned to describe the resource

      • links object(uri-map) | null

        The URLs of the Assigned Items of the Customer-Profile resource

      • policy_sid string | null

        The unique string of a policy.

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

      • sid string | null

        The unique string that identifies the resource.

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

      • status string | null

        The verification status of the Customer-Profile resource

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

      • status_callback string(uri) | null

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

      • url string(uri) | null

        The absolute URL of the Customer-Profile resource

      • valid_until string(date-time) | null

        The ISO 8601 date and time in GMT when the resource will be valid until.
GET /v1/CustomerProfiles 
curl \
 -X GET https://trusthub.twilio.com/v1/CustomerProfiles \
 --user "username:password"
Response examples (200) 
{
  "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"
  },
  "results": [
    {
      "account_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "email": "string",
      "friendly_name": "string",
      "links": {},
      "policy_sid": "string",
      "sid": "string",
      "status": "draft",
      "status_callback": "https://example.com",
      "url": "https://example.com",
      "valid_until": "2023-05-04T09:42:00+00:00"
    }
  ]
}