Saltar al contenido

List insurance certificate insured rows

Módulo Vendors

GET/insurance-certificate-insuredsinsuranceCertificateInsureds.list

A party a certificate of insurance names, with the endorsement it grants (1130). A name appears once per endorsement on a certificate, ignoring case and spacing (409). Returns a cursor page of insurance certificate insured rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

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

insuranceCertificateInsureds.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 InsuranceCertificateInsured

insuranceCertificateInsureds.list: InsuranceCertificateInsured
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the insurance certificate insured.
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.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row.
certificate_idstring (uuid)SíIdentifier of the certificate naming the party.
insured_namestringSíParty named, as printed.Restricciones: length 1 to 200
endorsement_kind"Additional Insured" | "Primary and Noncontributory" | "Waiver of Subrogation"SíEndorsement: Additional Insured, Primary and Noncontributory, or Waiver of Subrogation.
{
  "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",
      "certificate_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "insured_name": "Example Venue Owner LLC",
      "endorsement_kind": "Additional Insured"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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