Retrieve a list of all Regulations

GET /v2/RegulatoryCompliance/Regulations

TODO: Resource-level docs

Retrieve a list of all Regulations.

Query parameters

  • The type of End User the regulation requires - can be individual or business.

    Values are individual or business.

  • The ISO country code of the phone number's country.

  • The type of phone number that the regulatory requiremnt is restricting.

  • 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

  • OK

    Hide response attributes Show response attributes object
    • meta object
      Hide meta attributes Show meta attributes object
    • results array[object]
      Hide results attributes Show results attributes array[object]
      • end_user_type string | null

        The type of End User of the Regulation resource

        Values are individual or business.

      • friendly_name string | null

        A human-readable description of the Regulation resource

      • iso_country string | null

        The ISO country code of the phone number's country

      • number_type string | null

        The type of phone number restricted by the regulatory requirement

      • The sid of a regulation object that dictates requirements

      • sid string | null

        The unique string that identifies the Regulation resource

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

      • url string(uri) | null

        The absolute URL of the Regulation resource

GET /v2/RegulatoryCompliance/Regulations
curl \
 -X GET https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations \
 --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": [
    {
      "end_user_type": "individual",
      "friendly_name": "string",
      "iso_country": "string",
      "number_type": "string",
      "sid": "string",
      "url": "https://example.com"
    }
  ]
}
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": [
    {
      "end_user_type": "individual",
      "friendly_name": "string",
      "iso_country": "string",
      "number_type": "string",
      "sid": "string",
      "url": "https://example.com"
    }
  ]
}