Skip to main content

List number order documents

GET 
/number_order_documents

Gets a paginated list of number order documents.

Request​

Query Parameters

    filter[requirement_id] string

    Filter number order documents by requirement_id.

    filter[created_at][gt] string

    Filter number order documents after this datetime.

    filter[created_at][lt] string

    Filter number order documents from before this datetime.

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

Responses​

200: Successful response with a list of number order documents.

Schema

    data

    NumberOrderDocument[]

  • Array [

    • id uuid
    record_type string
    file_id string

    The id of the file to associate as a number order document.

    requirements_id string

    Unique id for a requirement.

    customer_reference string

    A customer reference string for customer look ups.

    requirement_type string

    Possible values: [address_proof, identification, reg_form]

    created_at datetime

    An ISO 8901 datetime string denoting when the number order document was uploaded.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta

    object

    url string

    URL with additional information on the error.

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/number_order_documents' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": [
    {
      "id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
      "record_type": "number_order_document",
      "file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
      "requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292",
      "customer_reference": "MY REF 001",
      "requirement_type": "address_proof",
      "created_at": "2018-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}