Create an opportunity

Opportunities module

POST/opportunitiesopportunities.create

An opportunity published from an approved requisition. Without posted compensation it shows Rate on Request, never zero. Creates an opportunity. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability opportunities.posting.write.
OAuth scopes: opportunities.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: OpportunityCreate

opportunities.create: OpportunityCreate
Field	Type	Required	Description
requisition_id	string (uuid) \| null	No	Identifier of the approved requisition the opportunity is published from; required to publish Contractor, Crew and Staff opportunities and fixed once published.
project_id	string (uuid)	Yes	Identifier of the project.
scope_node_id	string (uuid) \| null	No	Identifier of the scope node.
title	string	Yes	Opportunity title, Title Case.Constraints: length 1 to 300
role_type	ExternalRoleType	Yes	External role type (Section 4.4.2).Constraints: one of "Client", "Vendor", "Contractor", "Crew", "Staff", "Artist", "Artist Representative", "Sponsor"
role_code	RoleCode \| null	No
cat_urid	UridAtAnyGrain	No	URID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Constraints: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
description	string \| null	No	Description.Constraints: length 1 to 20000
venue_id	string (uuid) \| null	No	Identifier of the venue.
rate_type	RateType \| null	No
visibility	OpportunityVisibility	No	Who can see an opportunity.Constraints: one of "Invited", "Pool", "Network", "Public"
jurisdiction_id	JurisdictionId \| null	No
starts_on	string (date) \| null	No	First day of the work.
ends_on	string (date) \| null	No	Last day of the work.
pay_min_minor	integer (int64) \| null	No	Lower end of the posted pay range; null when not posted. Integer minor units of the resource currency; null means unpriced, never zero.
pay_max_minor	integer (int64) \| null	No	Upper end of the posted pay range; null when not posted. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string \| null	No	ISO 4217 currency of the posted pay.Constraints: pattern ^[A-Z]{3}$
deadline_at	string (date-time) \| null	No	Deadline for applications and bids. Bids stay sealed until it passes.
minimum_age	integer \| null	No	Minimum age for the work, 16 or older (Section 14.9).Constraints: range 16 to any
is_remote	boolean	No	Whether the work can be done remotely.

{
  "requisition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Stagehands for Harborfront Load-In",
  "role_type": "Crew",
  "description": "Six stagehands for a two-day load-in.",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "starts_on": "2026-10-08",
  "ends_on": "2026-10-08",
  "pay_min_minor": 3500,
  "pay_max_minor": 4500,
  "currency_code": "USD",
  "deadline_at": "2026-10-08T14:30:00Z",
  "minimum_age": 18,
  "is_remote": false
}

Response 201: Opportunity

opportunities.create: Opportunity
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the opportunity.
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.
requisition_id	string (uuid) \| null	Yes	Identifier of the approved requisition the opportunity is published from; required to publish Contractor, Crew and Staff opportunities and fixed once published.
project_id	string (uuid)	Yes	Identifier of the project.
scope_node_id	string (uuid) \| null	Yes	Identifier of the scope node.
title	string	Yes	Opportunity title, Title Case.Constraints: length 1 to 300
role_type	ExternalRoleType	Yes	External role type (Section 4.4.2).Constraints: one of "Client", "Vendor", "Contractor", "Crew", "Staff", "Artist", "Artist Representative", "Sponsor"
role_code	RoleCode \| null	Yes
cat_urid	UridAtAnyGrain	Yes	URID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Constraints: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
description	string \| null	Yes	Description.Constraints: length 1 to 20000
venue_id	string (uuid) \| null	Yes	Identifier of the venue.
rate_type	RateType \| null	Yes
visibility	OpportunityVisibility	Yes	Who can see an opportunity.Constraints: one of "Invited", "Pool", "Network", "Public"
opportunity_state	OpportunityState	Yes	Opportunity lifecycle state.Constraints: one of "Draft", "Pending Approval", "Published", "Paused", "Filled", "Closed", "Canceled"
jurisdiction_id	JurisdictionId \| null	Yes
starts_on	string (date) \| null	Yes	First day of the work.
ends_on	string (date) \| null	Yes	Last day of the work.
pay_min_minor	integer (int64) \| null	Yes	Lower end of the posted pay range; null when not posted. Integer minor units of the resource currency; null means unpriced, never zero.
pay_max_minor	integer (int64) \| null	Yes	Upper end of the posted pay range; null when not posted. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string \| null	Yes	ISO 4217 currency of the posted pay.Constraints: pattern ^[A-Z]{3}$
deadline_at	string (date-time) \| null	Yes	Deadline for applications and bids. Bids stay sealed until it passes.
minimum_age	integer \| null	Yes	Minimum age for the work, 16 or older (Section 14.9).Constraints: range 16 to any
is_remote	boolean	Yes	Whether the work can be done remotely.

{
  "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",
  "requisition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Stagehands for Harborfront Load-In",
  "role_type": "Crew",
  "role_code": "5000.50.01",
  "cat_urid": "4000.01",
  "description": "Six stagehands for a two-day load-in.",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "rate_type": "Day",
  "visibility": "Pool",
  "opportunity_state": "Published",
  "jurisdiction_id": "US-FL",
  "starts_on": "2026-10-08",
  "ends_on": "2026-10-08",
  "pay_min_minor": 3500,
  "pay_max_minor": 4500,
  "currency_code": "USD",
  "deadline_at": "2026-10-08T14:30:00Z",
  "minimum_age": 18,
  "is_remote": false
}

Code samples

curl -X POST "$XOS_BASE_URL/opportunities" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"requisition_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","scope_node_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","title":"Stagehands for Harborfront Load-In","role_type":"Crew","description":"Six stagehands for a two-day load-in.","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","starts_on":"2026-10-08","ends_on":"2026-10-08","pay_min_minor":3500,"pay_max_minor":4500,"currency_code":"USD","deadline_at":"2026-10-08T14:30:00Z","minimum_age":18,"is_remote":false}'

const { data } = await xos.opportunities.create({
    "requisition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "title": "Stagehands for Harborfront Load-In",
    "role_type": "Crew",
    "description": "Six stagehands for a two-day load-in.",
    "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "starts_on": "2026-10-08",
    "ends_on": "2026-10-08",
    "pay_min_minor": 3500,
    "pay_max_minor": 4500,
    "currency_code": "USD",
    "deadline_at": "2026-10-08T14:30:00Z",
    "minimum_age": 18,
    "is_remote": false
  });

response = xos.opportunities.create({"requisition_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "title": "Stagehands for Harborfront Load-In", "role_type": "Crew", "description": "Six stagehands for a two-day load-in.", "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "starts_on": "2026-10-08", "ends_on": "2026-10-08", "pay_min_minor": 3500, "pay_max_minor": 4500, "currency_code": "USD", "deadline_at": "2026-10-08T14:30:00Z", "minimum_age": 18, "is_remote": False})

xos opportunities create --data '{"requisition_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","scope_node_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","title":"Stagehands for Harborfront Load-In","role_type":"Crew","description":"Six stagehands for a two-day load-in.","venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","starts_on":"2026-10-08","ends_on":"2026-10-08","pay_min_minor":3500,"pay_max_minor":4500,"currency_code":"USD","deadline_at":"2026-10-08T14:30:00Z","minimum_age":18,"is_remote":false}'