Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.

GET /v2/HostedNumber/AuthorizationDocuments
Account sid auth token

Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.

Query parameters

  • Email string

    Email that this AuthorizationDocument will be sent to for signing.

  • Status string

    Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled Status Values for more information on each of these statuses.

    Values are opened, signing, signed, canceled, or failed.

  • 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
    • items array[object]
      Hide items attributes Show items attributes object
      • sid string | null

        A 34 character string that uniquely identifies this AuthorizationDocument.

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

      • address_sid string | null

        A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.

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

      • status string

        Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled Status Values for more information on each of these statuses.

        Values are opened, signing, signed, canceled, or failed.

      • email string | null

        Email that this AuthorizationDocument will be sent to for signing.

      • cc_emails array[string] | null

        Email recipients who will be informed when an Authorization Document has been sent and signed.

      • date_created string(date-time) | null

        The date this resource was created, given as GMT RFC 2822 format.

      • date_updated string(date-time) | null

        The date that this resource was updated, given as GMT RFC 2822 format.

      • url string(uri) | null
      • links object(uri-map) | null
    • 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 /v2/HostedNumber/AuthorizationDocuments 
curl \
 --request GET 'https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments' \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "key": "items",
    "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?Status=signed&Email=test%2Bhosted%40twilio.com&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "items": []
}
{
  "meta": {
    "key": "items",
    "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "items": [
    {
      "sid": "PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "email": "test+hosted@twilio.com",
      "links": {
        "dependent_hosted_number_orders": "https://numbers.twilio.com/v2/HostedNumber/AuthorizationDocuments/PXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DependentHostedNumberOrders"
      },
      "status": "signing",
      "cc_emails": [
        "test1@twilio.com",
        "test2@twilio.com"
      ],
      "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2017-03-28T20:06:39Z",
      "date_updated": "2017-03-28T20:06:39Z"
    }
  ]
}