Skip to content

Read what the share's person shared

Identity module

GET/work-detail-shares/{id}/detailsworkDetailShares.details

For a member of the engaging org: the shared categories the caller's project capabilities cover (safety readers and engagement editors for emergency contacts, engagement readers and shift editors for uniform sizes, hospitality readers for the rest), through `app.shared_work_details`. Nothing is returned once the share is revoked or the engagement is Complete or Canceled. The passport number is always masked. Each read is logged in the person's access log and the org's audit ledger. A rule that refuses the request returns 422 with `refusal` and `reason`.

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

Path and query parameters

workDetailShares.details: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the work detail share.

Response 200: SharedWorkDetails

workDetailShares.details: SharedWorkDetails
FieldTypeRequiredDescription
engagement_idstring (uuid)YesEngagement.
person_idstring (uuid) | nullYesPerson the engagement names.
org_idstring (uuid)YesEngaging org.
work_detail_share_idstring (uuid) | nullYesLive share; null when none stands.
shared_atstring (date-time) | nullYesWhen the share was given.
sharing_openbooleanYesThe engagement is Onboarding to Closing; a closed engagement reads nothing.
categoriesarray of WorkDetailCategoryYesCategories the person shared.
readablearray of WorkDetailCategoryYesShared categories the caller's project capabilities cover; the others come back null.
emergency_contactsarray of SharedEmergencyContact | nullYes
uniformSharedUniformSizes | nullYes
dietarySharedDietaryNeeds | nullYes
accessibilitySharedAccessibilityNeeds | nullYes
travelSharedTravelProfile | nullYes
passportSharedPassport | nullYes
{
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "work_detail_share_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "shared_at": "2026-10-08T14:30:00Z",
  "sharing_open": true,
  "categories": [
    "Dietary Needs"
  ],
  "readable": [
    "Dietary Needs"
  ],
  "emergency_contacts": [
    {
      "full_name": "Marco Marchetti",
      "relationship": "Brother",
      "phone_e164": "+13055550142",
      "alternate_phone_e164": "+13055550142",
      "email": "marco@example.com",
      "sort_order": 0
    }
  ],
  "uniform": {
    "shirt_size": "XXS",
    "jacket_size": "XXS",
    "pants_size": "32x32",
    "shoe_size": "US 10.5",
    "glove_size": "XXS",
    "hat_size": "7 1/4",
    "uniform_notes": "Prefers a relaxed cut."
  },
  "dietary": {
    "dietary_needs": [
      "Vegetarian"
    ],
    "allergies": "Peanuts, severe",
    "dietary_notes": "No pork."
  },
  "accessibility": {
    "accessibility_needs": [
      "Step-Free Access"
    ],
    "accessibility_notes": "Needs a seat near the stage door."
  },
  "travel": {
    "seat_preference": "Window",
    "meal_preference": "Vegetarian (VGML)",
    "home_airport": "MIA",
    "loyalty_programs": [
      {
        "program_kind": "Airline",
        "program_name": "SkyMiles",
        "member_number": "SM-0000-TEST"
      }
    ]
  },
  "passport": {
    "passport_number": null,
    "passport_number_last4": "TEST",
    "passport_number_masked": true,
    "passport_issuing_country": "US",
    "passport_expires_on": "2026-10-08",
    "passport_name": "IVY MARCHETTI"
  }
}

Code samples

curl -X GET "$XOS_BASE_URL/work-detail-shares/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/details" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.workDetailShares.details("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.work_detail_shares.details("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos work-detail-shares details 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f