Retrieve a list of all Supporting Document Types

GET /v2/RegulatoryCompliance/SupportingDocumentTypes

TODO: Resource-level docs

Retrieve a list of all Supporting Document Types.

Query parameters

  • 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
    • supporting_document_types array[object]
      Hide supporting_document_types attributes Show supporting_document_types attributes
      • fields array | null

        The required information for creating a Supporting Document

      • friendly_name string | null

        A human-readable description of the Supporting Document Type resource

      • machine_name string | null

        The machine-readable description of the Supporting Document Type resource

      • sid string | null

        The unique string that identifies the Supporting Document Type resource

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

      • url string(uri) | null

        The absolute URL of the Supporting Document Type resource
GET /v2/RegulatoryCompliance/SupportingDocumentTypes 
curl \
 -X GET https://numbers.twilio.com/v2/RegulatoryCompliance/SupportingDocumentTypes \
 --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"
  },
  "supporting_document_types": [
    {
      "fields": [],
      "friendly_name": "string",
      "machine_name": "string",
      "sid": "string",
      "url": "https://example.com"
    }
  ]
}