Documents

List carrier documents

Changed on

Return file metadata with each matching attachment. Shared files retain separate rows and relationship categories. Pagination follows relationships; missing files do not terminate traversal.

get/carriers/{carrierId}/documents

Request

  • Base URL: https://api.mvmnt.io/v1
  • URL: https://api.mvmnt.io/v1/carriers/{carrierId}/documents
  • Auth: HTTP bearer

Path parameters

carrierIdstring uuid required

Query parameters

pageSizeinteger
cursorstring

Cursor bound to this parent and filter; use the same scope on subsequent pages.

typestring

Match this relationship category, independently of the file's base category.

Response

Successful response

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "doc-inv-2025-001",
      "fileName": "invoice-2025-001.pdf",
      "extension": "pdf",
      "contentType": "application/pdf",
      "fileSize": 102400,
      "uploadUrl": "https://s3.amazonaws.com/bucket/key?signature=...",
      "downloadUrl": "https://s3.amazonaws.com/bucket/key?signature=...",
      "tags": {
        "invoiceNumber": "INV-2025-001",
        "customerPO": "PO-12345"
      },
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-15T10:35:00Z"
    }
  ],
  "pagination": {
    "pageSize": 50,
    "hasNextPage": true,
    "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
  }
}

Changes