/api/v1/locations/{id}/paperless/documents

GET

const url = 'https://example.com/api/v1/locations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/paperless/documents?page=1';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/locations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/paperless/documents?page=1'

Parameters

Path Parameters

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Query Parameters

string

<= 200 characters

page

integer

default: 1 >= 1 <= 500

thingId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

placeId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

200

Default Response

application/json

object

count

required

integer

>= -9007199254740991 <= 9007199254740991

page

required

integer

>= -9007199254740991 <= 9007199254740991

pageSize

required

integer

>= -9007199254740991 <= 9007199254740991

items

required

Array<object>

object

documentId

required

integer

>= -9007199254740991 <= 9007199254740991

title

required

string

kind

required

string

Allowed values: receipt invoice manual warranty_doc document

typeName

required

string | null

correspondent

required

string | null

createdOn

required

string | null

tags

required

Array<string>

linked

required

boolean

openUrl

required

string

Example

{
  "items": [
    {
      "kind": "receipt"
    }
  ]
}