For the complete documentation index, see llms.txt. This page is also available as Markdown.

Read Presence Feed

Reads the specified presence feed that was created using the Create Presence feed endpoint. The feed returned includes the user presence statuses that have changed since they were last read.

Read a presence status feed.

get

Returns the current presence status of company (pod) users if it has changed since the last read. Returns up to 500 records at a time.

Path parameters
feedIdstringRequired

Presence feed ID.

Header parameters
sessionTokenstringRequired

Session authentication token.

Responses
200

OK

application/json
categorystringRequired

Presence status. Possible values are:

  • UNDEFINED
  • AVAILABLE
  • BUSY
  • DO_NOT_DISTURB
  • ON_THE_PHONE
  • BE_RIGHT_BACK
  • IN_A_MEETING
  • AWAY
  • OUT_OF_OFFICE
  • OFF_WORK
  • OFFLINE
Example: AWAY
userIdinteger · int64Optional

The ID of the user to whom the presence state relates.

Example: 14568529068038
timestampinteger · int64Optional

The time, in milliseconds since Jan 1 1970, when the presence state was set.

Example: 1533928483800
get/v1/presence/feed/{feedId}/read

When calling this as an OBO-enabled endpoint, use the OBO User Authenticate token for sessionToken.

Last updated

Was this helpful?