List Documents

Log in to see full request history
Query Params
string

A valid filter for DocumentGET, as a json string

integer
≥ 1
Defaults to 1
integer
1 to 100
Defaults to 50
Responses

Response body
object
items
array of objects
required
Items*
object
integer
required

Id of record, used as primary key when looking up items using the API

date-time
required

Timestamp of the last time the object was modified

string | null

Full name of the user who last changed this document

integer
required

The Id of the user that last made changes to the object

date-time
required

Timestamp of when the object was first created

string | null

Full name of the user that created this document

integer
required

The Id of the user that first created the object

boolean
required

If this document is attached to an additional work order

string | null

Description/comment/notes

integer | null

Diary (if any) this document belongs to

integer | null

Document type

string | null

Type of document

boolean
Defaults to false

Show larger than normal in reports

string | null

Name of file. Used when downloading

date-time | null

When the document was filled with auto generated content

boolean
Defaults to false

Hide document in lists on mobile devices.

integer | null

Image height in pixels (if image, otherwise should be null)

integer | null

Image width in pixels (if image, otherwise should be null)

boolean
Defaults to true

Include in report

boolean
Defaults to false

Include on offer

date-time | null

When the content of the document was last changed

string
required
length ≤ 255

MIME type of document.

string | null

filename if filename is not null, otherwise title

integer
required

The Id of the associated project

string
required
length ≤ 10

The project number of the associated project

boolean
Defaults to false

Show in portal

integer
required

Size of document in bytes

string | null

Name of document. NOTE: Default value is filename without file extension.

date
required

When this document was uploaded

string | null

URL to document. NOTE: Cannot be used with data.

integer | null

Workorder this document belongs to

integer | null

The work order number of the associated work order

integer
≥ 1
integer
≥ 0
integer
≥ 1
integer
≥ 0

Language
Credentials
OAuth2
URL