List engagement document rows
Módulo Opportunities
GET/engagement-documentsengagementDocuments.list
A document in an engagement, under the canon Engagement-Document lifecycle. Returns a cursor page of engagement document rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad opportunities.engagement.read.
- Alcances de OAuth: opportunities.
- Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
- Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Restricciones: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Respuesta 200: una página de EngagementDocument
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the engagement document. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| engagement_id | string (uuid) | Sí | Identifier of the engagement. |
| document_id | string (uuid) | null | Sí | Identifier of the document. |
| title | string | Sí | Document title.Restricciones: length 1 to 300 |
| engagement_document_state | string | Sí | Engagement-Document lifecycle state. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| document_kind | "Offer" | "Agreement" | "Statement of Work" | "Non-Disclosure Agreement" | "Rider" | "Advance Packet" | "Insurance Certificate" | "Lien Waiver" | "Settlement" | "Proof of Performance" | "Content Consent" | Sí | Kind of document. |
| expires_on | string (date) | null | Sí | Last day the document is valid, for documents that expire. |
{
"data": [
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"title": "Statement of Work",
"engagement_document_state": "Proposed",
"document_kind": "Offer",
"expires_on": "2026-10-08"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/engagement-documents" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.engagementDocuments.listAll()) {
console.log(row);
}for row in xos.engagement_documents.list_all():
print(row)xos engagement-documents list --all