Get an opportunity requirement
Módulo Opportunities
GET/opportunity-requirements/{id}opportunityRequirements.get
A requirement of an opportunity: a certification through a canon compliance tag, insurance or equipment. Returns one opportunity requirement with its `ETag`. A opportunity requirement the caller may not see returns 404.
- Requiere la capacidad opportunities.posting.read.
- Alcances de OAuth: opportunities.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the opportunity requirement. |
| 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_]*)*$ |
Respuesta 200: OpportunityRequirement
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the opportunity requirement. |
| 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. |
| opportunity_id | string (uuid) | Sí | Identifier of the opportunity. |
| certification_id | string (uuid) | null | Sí | Identifier of the certification. |
| insurance_minimum_minor | integer (int64) | null | Sí | Insurance minimum, when the requirement is insurance. Integer minor units of the resource currency; null means unpriced, never zero. |
| requirement_kind | "Certification" | "Insurance" | "Equipment" | Sí | Kind of requirement. |
| description | string | Sí | What is required.Restricciones: length 1 to 20000 |
| currency_code | string | null | Sí | ISO 4217 currency of the insurance minimum.Restricciones: pattern ^[A-Z]{3}$ |
{
"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",
"opportunity_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"certification_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"insurance_minimum_minor": 100000000,
"requirement_kind": "Certification",
"description": "Rigging certification, current.",
"currency_code": "USD"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/opportunity-requirements/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.opportunityRequirements.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.opportunity_requirements.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos opportunity-requirements get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f