v1

latestOpenAPI 3.0.12026-07-144840447.2 KB

DMS (GED)

List Company's DMS Files

This endpoint returns a list of DMS files of the company.

ℹ️ This endpoint requires one of the following scopes: dms_files:all, dms_files:readonly

get/api/external/firm/v1/companies/{company_id}/dms/files

Path parameters

company_idinteger required

Existing company identifier (id)

Query parameters

cursorstring

Example:dXBkYXRlZF9hdDoxNjc0MTIzNDU2

Cursor for pagination. Use this to fetch the next set of results. The cursor is an opaque string returned in the previous response's metadata. Leave empty for the first request.

limitinteger

Example:20

Number of items to return per request. Defaults to 20 if not specified. Must be between 1 and 100.

filterstring

Example:[{"field": "id", "operator": "in", "value": "[42,43]"}]

You can choose to filter items on specific fields. Available fields and values:

id, parent_folder_id: lt, lteq, gt, gteq, eq, not_eq, in, not_in

Response

Returns the list of DMS files of the company.

has_moreboolean required

Indicates whether additional results are available beyond this set. Use this flag to determine if another request is needed.

next_cursorstring nullable required

Cursor to retrieve the next set of results. Include this value in the cursor parameter of your next request to fetch subsequent items. A null next_cursor in the response indicates no further results.

Example response

{
  "has_more": true,
  "next_cursor": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2",
  "items": [
    {
      "id": 124,
      "name": "file.pdf",
      "path": "/path/to/file.pdf",
      "parent_folder": {
        "id": 234
      },
      "url": "https://example.com/path/to/file.pdf",
      "created_at": "2023-08-30T10:08:08.146343Z",
      "updated_at": "2023-08-30T10:08:08.146343Z"
    }
  ]
}