Skip to content

Get a person calendar feed

Platform module

GET/person-calendar-feeds/{id}personCalendarFeeds.get

A person's own iCalendar feed across every org they work with through an engagement (1410): their published shifts and the meetings, milestones and deadlines shared with them. Only a hash of the token is kept; the token is shown once by personCalendarFeeds.create and personCalendarFeeds.rotate, and deleting the feed revokes it for good. Returns one person calendar feed with its `ETag`. A person calendar feed the caller may not see returns 404.

  • Requires the capability me.calendar_feeds.write.
  • OAuth scopes: me.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

personCalendarFeeds.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the person calendar feed.
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: PersonCalendarFeed

personCalendarFeeds.get: PersonCalendarFeed
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the person calendar feed.
created_atstring (date-time)YesWhen the row was created.
updated_atstring (date-time)YesWhen the row was last updated.
person_idstring (uuid)YesIdentifier of the person who owns the feed; always the caller.
token_hintstringYesLast four characters of the token.Constraints: length 1 to 4
last_accessed_atstring (date-time) | nullYesLast time a calendar fetched the feed.
rotated_atstring (date-time) | nullYesWhen the token was last replaced.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "token_hint": "a1b2",
  "last_accessed_at": "2026-10-08T14:30:00Z",
  "rotated_at": "2026-10-08T14:30:00Z"
}

Code samples

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