Documents

List all document links

Changed on

List all documents links ordered by created_at descending.

get/document_links

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/document_links
  • Auth: HTTP bearer

Query parameters

linked_record_typestring

The linked_record_type of the document to filter on.

linked_resource_idstring uuid

The linked_resource_id of the document to filter on.

Consolidated filter parameter for document links (deepObject style). Originally: filter[linked_record_type], filter[linked_resource_id]

{
  "linked_record_type": "porting_order",
  "linked_resource_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
}
sizeinteger

The size of the page

numberinteger

The page number to load

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Response

Successful response

Example response

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "document_link",
      "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
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status