List number order documents
GET/number_order_documents
Gets a paginated list of number order documents.
Request
Query Parameters
Filter number order documents by requirement_id
.
Filter number order documents after this datetime.
Filter number order documents from before this datetime.
Possible values: >= 1
Default value: 1
The page number to load
Possible values: >= 1
and <= 250
Default value: 20
The size of the page
Responses
200: Successful response with a list of number order documents.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
NumberOrderDocument[]
The id of the file to associate as a number order document.
Unique id for a requirement.
A customer reference string for customer look ups.
Possible values: [address_proof
, identification
, reg_form
]
An ISO 8901 datetime string denoting when the number order document was uploaded.
meta
object
{
"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
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
meta
object
URL with additional information on the error.
{
"errors": [
{
"code": "10007",
"title": "Unexpected error",
"detail": "An unexpected error occured.",
"source": {
"pointer": "/base",
"parameter": "string"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10015"
}
}
]
}