Skip to content

List person calendar feed rows

Platform module

GET/person-calendar-feedspersonCalendarFeeds.list

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 a cursor page of person calendar feed rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requires the capability me.calendar_feeds.write.
  • OAuth scopes: me.
  • Cursor-paginated: limit, cursor, fields, sort and filter apply.
  • Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

personCalendarFeeds.list: Path and query parameters
FieldTypeRequiredDescription
limitLimitNoPage size. Default 50, maximum 200.Constraints: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
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_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of PersonCalendarFeed

personCalendarFeeds.list: 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.
{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/person-calendar-feeds" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.personCalendarFeeds.listAll()) {
  console.log(row);
}
for row in xos.person_calendar_feeds.list_all():
    print(row)
xos person-calendar-feeds list --all