Retrieve a list of all Policys.

GET /v1/Policies
Account sid auth token

Retrieve a list of all Policys.

Query parameters

  • 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 identifies the Policy 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

        A human-readable description that is assigned to describe the Policy resource. Examples can include Primary Customer profile policy

      • requirements

        The SID of an object that holds the policy information

      • url string(uri) | null

        The absolute URL of the Policy 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 /v1/Policies 
curl \
 --request GET 'https://trusthub.twilio.com/v1/Policies' \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "key": "results",
    "url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "results": []
}
{
  "meta": {
    "key": "results",
    "url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://trusthub.twilio.com/v1/Policies?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "results": [
    {
      "sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://trusthub.twilio.com/v1/Policies/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "requirements": {
        "end_user": [
          {
            "url": "/EndUserTypes/customer_profile_business_information",
            "name": "Business Information",
            "type": "customer_profile_business_information",
            "fields": [
              "business_type",
              "business_registration_number",
              "business_name",
              "business_registration_identifier",
              "business_identity",
              "business_industry",
              "website_url",
              "business_regions_of_operation",
              "social_media_profile_urls"
            ],
            "requirement_name": "customer_profile_business_information"
          },
          {
            "url": "/EndUserTypes/authorized_representative_1",
            "name": "Authorized Representative 1",
            "type": "authorized_representative_1",
            "fields": [
              "first_name",
              "last_name",
              "email",
              "phone_number",
              "business_title",
              "job_position"
            ],
            "requirement_name": "authorized_representative_1"
          },
          {
            "url": "/EndUserTypes/authorized_representative_2",
            "name": "Authorized Representative 2",
            "type": "authorized_representative_2",
            "fields": [
              "first_name",
              "last_name",
              "email",
              "phone_number",
              "business_title",
              "job_position"
            ],
            "requirement_name": "authorized_representative_2"
          }
        ],
        "supporting_document": [
          [
            {
              "name": "Physical Business Address",
              "type": "document",
              "description": "Customer Profile HQ Physical Address",
              "requirement_name": "customer_profile_address",
              "accepted_documents": [
                {
                  "url": "/SupportingDocumentTypes/customer_profile_address",
                  "name": "Physical Business Address",
                  "type": "customer_profile_address",
                  "fields": [
                    "address_sids"
                  ]
                }
              ]
            }
          ]
        ],
        "supporting_trust_products": [],
        "supporting_customer_profiles": []
      },
      "friendly_name": "Primary Customer Profile of type Business"
    }
  ]
}