Get an opportunity requirement
Opportunities module
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.
- Requires the capability opportunities.posting.read.
- OAuth scopes: opportunities.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the opportunity requirement. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: OpportunityRequirement
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the opportunity requirement. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| opportunity_id | string (uuid) | Yes | Identifier of the opportunity. |
| certification_id | string (uuid) | null | Yes | Identifier of the certification. |
| insurance_minimum_minor | integer (int64) | null | Yes | Insurance minimum, when the requirement is insurance. Integer minor units of the resource currency; null means unpriced, never zero. |
| requirement_kind | "Certification" | "Insurance" | "Equipment" | Yes | Kind of requirement. |
| description | string | Yes | What is required.Constraints: length 1 to 20000 |
| currency_code | string | null | Yes | ISO 4217 currency of the insurance minimum.Constraints: 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"
}Code samples
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