Appearance
Document
As a partner you can fetch all documents that you have access to. The documents you can access are for companies that you have been associated with.
GET /partner/document
Get documents that belongs to companies associated with the authenticated partner.
GET /partner/document
Get documents that belongs to companies associated with the authenticated partner. There are multiple ways to filter and limit the query for the data needed. It is highly recommended to specify the query as much as possible to increase performance and limit query time.
Query param | Description |
---|---|
limit | Limit the no of results to return.?limit=10 would return max 10 documents. |
skip | Used in combination with limit. ?limit=10&skip=10 would return document number 10 to 20. |
sort | Sort the result according to a specific property. Example ?sort=createdAt or ?sort=-createdAt |
fields | Specify which properties to return. Useful to speed up and limit the data. ?fields=status,createdAt |
(property) | You can specify any property to use in and filter, for example ?status=draft&companyUserId=1 would only return documents that fulfulls that specific conditions. |
filter | Useful to build more complex query filters. ?filter={"$or":[{"key1":"value1"},{"key2":"value2"}]} with operations such as $eq, $gt, $gte, $lt, $lte, $ne, $in, $nin and more. |