Skip to content

Get an application

Opportunities module

GET/applications/{id}applications.get

An application to an opportunity, with a consented profile snapshot. Returns one application with its `ETag`. A application the caller may not see returns 404.

  • Requires the capability opportunities.application.read.
  • OAuth scopes: opportunities.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

applications.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the application.
fieldsFieldsNoSparse 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: Application

applications.get: Application
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the application.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
opportunity_idstring (uuid)YesIdentifier of the opportunity.
profile_share_idstring (uuid) | nullYesIdentifier of the consented profile snapshot.
availability_confirmedbooleanYesWhether the applicant confirmed availability.
application_stateApplicationStateYesApplication lifecycle state.Constraints: one of "Submitted", "In Review", "Shortlisted", "Offered", "Accepted", "Declined", "Withdrawn", "Not Selected"
applicant_person_idstring (uuid) | nullYesIdentifier of the applying person.
applicant_organization_idstring (uuid) | nullYesIdentifier of the applying external account.
submitted_bystring (uuid) | nullYesIdentifier of the person who submitted, set from the session: the applicant, their representative or an account administrator.
cover_notestring | nullYesNote from the applicant.Constraints: length 1 to 20000
proposed_fee_minorinteger (int64) | nullYesFee the applicant proposes instead of the posted one (artists). Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullYesISO 4217 currency of the proposed fee.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",
  "profile_share_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "availability_confirmed": true,
  "application_state": "Submitted",
  "applicant_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "applicant_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "submitted_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "cover_note": "Available for both show days.",
  "proposed_fee_minor": 250000,
  "currency_code": "USD"
}

Code samples

curl -X GET "$XOS_BASE_URL/applications/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.applications.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.applications.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos applications get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f