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

GET

const url = 'https://example.com/api/v1/locations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/paperless/status';
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/status

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)$/

Responses

200

Default Response

application/json

object

connected

required

boolean

reachable

required

boolean | null

version

required

string | null

error

required

Any of:

string
null

string

Allowed values: private_address http_public unreachable timeout redirect auth_failed not_paperless too_old not_found too_large failed

url

required

string | null

Example

{
  "error": "private_address"
}