Get an offer
People module
GET/offers/{id}offers.get
Terms issued to a person or organization: accepted, countered or declined. Returns one offer with its `ETag`. A offer the caller may not see returns 404.
- Requires the capability people.profile.read.
- OAuth scopes: people.
- 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 offer. |
| 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: Offer
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the offer. |
| 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. |
| application_id | string (uuid) | Yes | Identifier of the application the offer answers. |
| person_id | string (uuid) | null | Yes | Identifier of the offered person. |
| organization_id | string (uuid) | null | Yes | Identifier of the offered organization. |
| rate_type | RateType | null | Yes | |
| expires_at | string (date-time) | null | Yes | When the terms in force lapse unanswered. |
| offer_state | string | Yes | Offer state. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| responded_at | string (date-time) | null | Yes | When the offer was answered. |
| version_number | integer | Yes | Version of the terms in force, issued by the database; the highest is in force.Constraints: range 0 to any |
| proposed_side | "Organization" | "Party" | Yes | Side that proposed the terms in force. |
| amount_minor | integer (int64) | null | Yes | Offered amount per rate unit; null when the version leaves the amount open. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | null | Yes | ISO 4217 currency of the amount.Constraints: pattern ^[A-Z]{3}$ |
| starts_on | string (date) | null | Yes | First day of the work offered. |
| ends_on | string (date) | null | Yes | Last day of the work offered. |
| message | string | null | Yes | Message to the other side with the terms. Visible to both sides.Constraints: length 1 to 4000 |
{
"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",
"application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"rate_type": "Day",
"expires_at": "2026-10-08T14:30:00Z",
"offer_state": "Active",
"responded_at": "2026-10-08T14:30:00Z",
"version_number": 1,
"proposed_side": "Organization",
"amount_minor": 45000,
"currency_code": "USD",
"starts_on": "2026-10-08",
"ends_on": "2026-10-08",
"message": "Rate includes the load-in day."
}Code samples
curl -X GET "$XOS_BASE_URL/offers/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.offers.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.offers.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos offers get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f