Retrieve a list of all Supporting Document for an account

GET /v1/SupportingDocuments

TODO: Resource-level docs

Retrieve a list of all Supporting Document for an account.

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

      • attributes

        The set of parameters that compose the Supporting Documents resource

      • 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

      • friendly_name string | null

        The string that you assigned to describe the resource

      • mime_type string | null

        The image type of the file

      • sid string | null

        The unique string that identifies the resource

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

      • status string | null

        The verification status of the Supporting Document resource

        Values are draft, pending-review, rejected, approved, expired, or provisionally-approved.

      • type string | null

        The type of the Supporting Document

      • url string(uri) | null

        The absolute URL of the Supporting Document resource
GET /v1/SupportingDocuments 
curl \
 -X GET https://trusthub.twilio.com/v1/SupportingDocuments \
 --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",
      "friendly_name": "string",
      "mime_type": "string",
      "sid": "string",
      "status": "draft",
      "type": "string",
      "url": "https://example.com"
    }
  ]
}