Skip to content

documents

Query

The documents query returns a list of documents that your organisation has access to

query {
documents(
organisationId: UUID!
filter: DocumentsFilterInput
start: Int = 0
count: Int = 100
ordering: DocumentOrdering = "Id"
ascending: Boolean = false
): DocumentQuery!
}
ArgumentTypeDefaultDescription
organisationId*UUID!The ID of the organisation making the query
filterDocumentsFilterInputThe filters to apply to the search
startInt0The index of the first booking in the list to be returned
countInt100The number of bookings to be returned. Max 1000
orderingDocumentOrdering"Id"The ordering method of the documents being returned.
ascendingBooleanfalseA flag indicating whether the documents are in ascending order by the ordering method. True indicates ascending order. False indicates descending order.

DocumentQuery (DocumentQuery!)

query Documents($organisationId: UUID!, $filter: DocumentsFilterInput, $start: Int, $count: Int, $ordering: DocumentOrdering, $ascending: Boolean) {
documents(organisationId: $organisationId, filter: $filter, start: $start, count: $count, ordering: $ordering, ascending: $ascending) {
start
pageSize
totalPages
totalRecords
data {
id
description
updateDate
}
}
}
{
"data": {
"documents": {
"start": 0,
"pageSize": 100,
"totalPages": 5,
"totalRecords": 0,
"data": [
{
"id": "example",
"description": "",
"updateDate": "2026-03-28T19:00:00Z"
}
]
}
}
}