> ## Documentation Index > Fetch the complete documentation index at: https://help.gorelo.io/llms.txt > Use this file to discover all available pages before exploring further. # Lists the service provider's documents. > Active documents only, unless statusIds names Archived. Archiving a document archives every document below it. To pick up only what changed since a previous sync, pass updatedSince: a new document counts as updated when it was created, so it is included. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/documents openapi: 3.0.4 info: title: Public API description: Gorelo Public API documentation. version: 1.0.0 servers: - url: https://api.usw.gorelo.io description: US - url: https://api.aue.gorelo.io description: Australia security: - ApiKeyAuth: [] tags: - name: Attachments description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs." - name: Alerts description: Alerts management operations - name: Assets description: Assets management operations - name: Billing description: Billing management operations - name: Tickets description: Tickets management operations - name: Clients description: Clients management operations - name: Contacts description: Contacts management operations - name: Deletions description: Deletions management operations - name: Documents description: Documents management operations - name: Forms description: Forms management operations - name: Organization description: Organization management operations - name: Projects description: Projects management operations paths: /v1/documents: get: tags: - Documents summary: Lists the service provider's documents. description: "Active documents only, unless statusIds names Archived. Archiving a\r\ndocument archives every document below it. To pick up only what changed since a previous\r\nsync, pass updatedSince: a new document counts as updated when it was\r\ncreated, so it is included." operationId: get_v1_documents parameters: - name: Cursor in: query description: >- Opaque pagination cursor from a previous page; omit for the first page. schema: type: string - name: PageSize in: query description: >- Number of items per page, 1-200 (default 50). Out of range is rejected, not clamped. schema: type: integer format: int32 default: 50 - name: StatusIds in: query description: >- Comma-separated status ids: 1 Active, 2 Archived. Omitted returns Active only (archived excluded). Any other id is a 400. schema: type: string - name: ClientIds in: query description: >- Comma-separated client ids. Returns only those clients' documents, never internal ones. schema: type: string - name: IsInternal in: query description: >- `true` for internal documents only, `false` for client documents only. schema: type: boolean - name: ParentDocumentId in: query description: Only the documents nested directly under this document. schema: type: string format: uuid - name: IsStarred in: query description: Keeps only starred (`true`) or unstarred (`false`) documents. schema: type: boolean - name: IsPublishedToPortal in: query description: >- Keeps only documents published (`true`) or not published (`false`) to the client portal. schema: type: boolean - name: IsPublicLinkEnabled in: query description: >- Keeps only documents whose public link is on (`true`) or off (`false`). schema: type: boolean - name: Query in: query description: Keyword matched against the title. Max 200 characters. schema: type: string - name: UpdatedSince in: query description: >- Keeps only documents updated at or after this UTC instant (ISO 8601). A document never edited since it was created counts as updated at its creation time. schema: type: string format: date-time - name: UpdatedBefore in: query description: Keeps only documents updated strictly before this UTC instant. schema: type: string format: date-time - name: CreatedSince in: query description: >- Keeps only documents created at or after this UTC instant. Restoring a version resets a document's created time. schema: type: string format: date-time - name: CreatedBefore in: query description: Keeps only documents created strictly before this UTC instant. schema: type: string format: date-time - name: SortBy in: query description: >- Sort field: `createdOn` (default), `updatedOn` or `documentOrder` (the order the app shows siblings in; use it with parentDocumentId). schema: type: string default: createdOn - name: SortOrder in: query description: 'Sort direction: `asc` or `desc` (default).' schema: type: string default: desc responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/DocumentListItemModelListBaseResponse' application/json: schema: $ref: '#/components/schemas/DocumentListItemModelListBaseResponse' text/json: schema: $ref: '#/components/schemas/DocumentListItemModelListBaseResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ObjectBaseResponse' application/json: schema: $ref: '#/components/schemas/ObjectBaseResponse' text/json: schema: $ref: '#/components/schemas/ObjectBaseResponse' '401': description: Unauthorized content: text/plain: schema: $ref: '#/components/schemas/ObjectBaseResponse' application/json: schema: $ref: '#/components/schemas/ObjectBaseResponse' text/json: schema: $ref: '#/components/schemas/ObjectBaseResponse' '500': description: Internal Server Error content: text/plain: schema: $ref: '#/components/schemas/ObjectBaseResponse' application/json: schema: $ref: '#/components/schemas/ObjectBaseResponse' text/json: schema: $ref: '#/components/schemas/ObjectBaseResponse' components: schemas: DocumentListItemModelListBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' IsSuccess: type: boolean Data: type: array items: $ref: '#/components/schemas/DocumentListItemModel' nullable: true DataContext: $ref: '#/components/schemas/PaginationDataContext' Notifications: type: array items: $ref: '#/components/schemas/Error' additionalProperties: false ObjectBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' IsSuccess: type: boolean Data: nullable: true DataContext: $ref: '#/components/schemas/ErrorDataContext' Notifications: type: array items: $ref: '#/components/schemas/Error' additionalProperties: false HttpStatusCode: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 DocumentListItemModel: type: object properties: Id: type: string description: Document identifier. format: uuid Title: type: string description: Title. ParentDocumentId: type: string description: >- The document this one is nested under; null for a top-level document. format: uuid nullable: true RootDocumentId: type: string description: >- The top-level document of this document's tree; its own id when it is top level. format: uuid Depth: type: integer description: >- How deep the document is nested: 0 for a top-level document, 1 for its children, and so on. format: int32 ChildCount: type: integer description: >- Number of documents nested directly under this one, archived ones included. format: int32 DocumentOrder: type: integer description: >- Position among the documents that share its parent, lowest first. Read-only. format: int32 ClientId: type: integer description: The client the document belongs to; null for an internal document. format: int64 nullable: true IsStarred: type: boolean description: >- Whether the document is starred. A star is shared by everyone in the account, not kept per user. PublicLinkEnabled: type: boolean description: Whether the document can be read by anyone holding its public link. PublishToPortalEnabled: type: boolean description: Whether the document is published to the client portal. AlternateName: type: string description: >- The name the document is shown under in the client portal; null when none is set. nullable: true Status: $ref: '#/components/schemas/CodeModel' CreatedOn: type: string description: When the document was created (UTC). format: date-time CreatedById: type: integer description: >- Technician who created the document; 0 when it was created through the API. format: int64 UpdatedOn: type: string description: >- When the document was last changed (UTC); its creation time if it has not been changed since. format: date-time nullable: true UpdatedById: type: integer description: >- Technician who last changed the document, or who created it if it has not been changed since; 0 when that came through the API. format: int64 nullable: true additionalProperties: false description: A document as it appears in the document list. PaginationDataContext: type: object properties: Pagination: $ref: '#/components/schemas/PaginatedResponse' additionalProperties: false description: "The `DataContext` of a cursor-paginated success response: carries the paging metadata\r\nfor the returned page." Error: type: object properties: Code: pattern: ^[0-9]{6}$ type: string description: 6-digit MMTTNN error code. See the Public API error-code registry. example: '070101' Message: type: string PropertyName: type: string nullable: true ActionHint: type: string nullable: true DocUrl: type: string nullable: true additionalProperties: false ErrorDataContext: type: object properties: TraceId: type: string description: Request correlation id. Quote this when reporting a problem. nullable: true additionalProperties: false description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest." CodeModel: type: object properties: Id: type: integer description: >- Numeric identifier of the coded value (e.g. status, priority, type, or source id). format: int64 example: 1 Name: type: string description: Display name of the coded value. additionalProperties: false description: >- A coded value, such as a status, priority, type or source, as an id and a display name. PaginatedResponse: type: object properties: NextCursor: type: string nullable: true PreviousCursor: type: string nullable: true HasMore: type: boolean HasPrevious: type: boolean TotalCount: type: integer format: int32 additionalProperties: false securitySchemes: ApiKeyAuth: type: apiKey description: >- Your Gorelo API key. See [Generate API key](/generate-api-key). If your data is hosted in Australia, click the base URL at the top of this page and select `https://api.aue.gorelo.io`. name: X-API-Key in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.