List files in a batch

curl "${API_ROOT}/v2/batches/<BATCH-ID>/files" \
  -H "Authorization: Bearer ${API_TOKEN}" \
  -H "IB-Context: ${IB_CONTEXT}"

{
  "nodes": [
    {
      "full_path": "/path/to/document1.pdf",
      "metadata": {
        "node_type": "file",
        "size": 1024,
        "modified_timestamp": 1647532800
      },
      "perms": {
        "can_read": true,
        "can_write": true,
        "can_delete": true
      },
      "name": "document1.pdf"
    },
    {
      "full_path": "/path/to/document2.pdf",
      "metadata": {
        "node_type": "file",
        "size": 2048,
        "modified_timestamp": 1647619200
      },
      "perms": {
        "can_read": true,
        "can_write": false,
        "can_delete": false
      },
      "name": "document2.pdf"
    }
  ],
  "next_page_token": "eyJwYWdlIjogMn0=",
  "has_more": true
}

Return a list of files in a batch.

Authentication

AuthorizationBearer

Bearer HTTP authentication.

Path parameters

batch_idintegerRequired

The batch ID.

Query parameters

page_sizeintegerOptional

The number of files to return in each page.

start_tokenstringOptional

The token to start the list from.

Response

Request successful.

nodeslist of objects

List of files in the batch.

next_page_tokenstring

Token for retrieving the next page of results.

has_moreboolean

Indicates whether there are more files to be retrieved.

Errors

404

Not Found Error

List files in a batch

Authentication

Path parameters

Headers

Query parameters

Response

Errors

Authentication

Path parameters

Headers

Query parameters

Response

Errors

$	curl "${API_ROOT}/v2/batches/<BATCH-ID>/files" \
>	-H "Authorization: Bearer ${API_TOKEN}" \
>	-H "IB-Context: ${IB_CONTEXT}"

1	{
2	"nodes": [
3	{
4	"full_path": "/path/to/document1.pdf",
5	"metadata": {
6	"node_type": "file",
7	"size": 1024,
8	"modified_timestamp": 1647532800
9	},
10	"perms": {
11	"can_read": true,
12	"can_write": true,
13	"can_delete": true
14	},
15	"name": "document1.pdf"
16	},
17	{
18	"full_path": "/path/to/document2.pdf",
19	"metadata": {
20	"node_type": "file",
21	"size": 2048,
22	"modified_timestamp": 1647619200
23	},
24	"perms": {
25	"can_read": true,
26	"can_write": false,
27	"can_delete": false
28	},
29	"name": "document2.pdf"
30	}
31	],
32	"next_page_token": "eyJwYWdlIjogMn0=",
33	"has_more": true
34	}