Saltar al contenido

List integration rows

Módulo Settings

GET/integrationsintegrations.list

An integration connection (Section 17). Credentials are stored in Supabase Vault through the credential action and never returned. Returns a cursor page of integration rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad org.settings.read.
  • Alcances de OAuth: org.
  • 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

integrations.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fieldsFieldsNoSparse 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_]*)*$
sortSortNoSort 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_]*)*$
filterFilterNoFilter 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 Integration

integrations.list: Integration
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the integration.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
provider_codestringSíProvider.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
last_synced_atstring (date-time) | nullSíLast successful sync.
display_namestringSíName the org gives the connection.Restricciones: length 1 to 120
external_account_idstring | nullSíProvider tenant, company or workspace id.Restricciones: length 1 to 255
connection_state"Pending" | "Connected" | "Error" | "Paused" | "Disconnected"SíConnection state; changes through the transitions action.
credential_kind"OAuth Token" | "API Key" | "Service Account" | nullSíKind of the stored Vault credential.
credential_expires_atstring (date-time) | nullSíWhen the stored credential expires.
last_error_codestring | nullSíRule code of the last connection error.Restricciones: pattern ^[a-z][a-z0-9_]*$
last_error_messagestring | nullSíProvider message of the last connection error.Restricciones: length 1 to 1000
{
  "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",
      "provider_code": "xero",
      "last_synced_at": "2026-10-08T14:30:00Z",
      "display_name": "Northwind Xero",
      "external_account_id": "tenant-nwl",
      "connection_state": "Connected",
      "credential_kind": "OAuth Token",
      "credential_expires_at": "2026-10-08T14:30:00Z",
      "last_error_code": "credential_refused",
      "last_error_message": "Xero refused the token."
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/integrations" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.integrations.listAll()) {
  console.log(row);
}
for row in xos.integrations.list_all():
    print(row)
xos integrations list --all