Skip to main content

List all document links

GET 
/document_links

List all documents links ordered by created_at descending.

Request​

Query Parameters

    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

    filter[document_id] uuid

    Identifies the associated document to filter on.

    filter[linked_record_type] string

    The linked_record_type of the document to filter on.

    filter[linked_resource_id] uuid

    The linked_resource_id of the document to filter on.

Responses​

200: Successful response

Schema

    data object[]

    meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code intrequired
    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

  • ]

Request samples

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

Response samples

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": true,
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "document_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "linked_record_type": "porting_order",
      "linked_resource_id": "132091b4-442b-4a2a-b87f-61e707e46d54"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}