List agreement rows

Módulo People

GET/agreementsagreements.list

A contractor MSA, offer letter or crew agreement with token signing. A signed agreement cannot be revoked or unsigned. Returns a cursor page of agreement rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad people.profile.read.
Alcances de OAuth: people.
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

agreements.list: 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 Agreement

agreements.list: Agreement
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the agreement.
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.
title	string	Sí	Agreement title.Restricciones: length 1 to 300
agreement_state	"Proposed" \| "Sent" \| "Signed" \| "Superseded" \| "Expired" \| "Canceled"	Sí	Agreement state.
signed_at	string (date-time) \| null	Sí	When the agreement was signed.
agreement_kind	"Offer Letter" \| "Contractor Agreement" \| "Master Services Agreement" \| "Non-Disclosure Agreement"	Sí	Kind of agreement.
body	string	Sí	Full text the signer reads and signs; changes only while Proposed.Restricciones: length 1 to 20000
project_id	string (uuid) \| null	Sí	Identifier of the project the agreement covers.
offer_id	string (uuid) \| null	Sí	Identifier of the offer the agreement follows.
person_id	string (uuid) \| null	Sí	Identifier of the person party to the agreement.
counterparty_id	string (uuid) \| null	Sí	Identifier of the external organization party to the agreement.
token_expires_at	string (date-time) \| null	Sí	When the signing link stops working.
signed_name	string \| null	Sí	Name the signer typed as their signature.Restricciones: length 1 to 300
signed_body_sha256	string \| null	Sí	SHA-256 of the text that was signed, lowercase hex.Restricciones: pattern ^[0-9a-f]{64}$

{
  "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",
      "title": "Crew Agreement 2026",
      "agreement_state": "Proposed",
      "signed_at": "2026-10-08T14:30:00Z",
      "agreement_kind": "Offer Letter",
      "body": "The crew member agrees to the call times in the schedule.",
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "offer_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "token_expires_at": "2026-10-08T14:30:00Z",
      "signed_name": "Alex Rivera",
      "signed_body_sha256": "9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/agreements" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.agreements.listAll()) {
  console.log(row);
}

for row in xos.agreements.list_all():
    print(row)

xos agreements list --all