# Get Presence

## GET /v2/user/presence

> Get presence information about the requesting user.

```json
{"openapi":"3.1.1","info":{"title":"Pod API","version":"20.17.1"},"servers":[{"url":"http://yourpodURL.symphony.com/pod"}],"paths":{"/v2/user/presence":{"get":{"summary":"Get presence information about the requesting user.","parameters":[{"schema":{"type":"string"},"name":"sessionToken","description":"Session authentication token.","in":"header","required":true}],"tags":["Presence"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2Presence"}}}},"400":{"description":"Client error, see response body for further details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Unauthorized: Invalid session token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Server error, see response body for further details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"V2Presence":{"allOf":[{"$ref":"#/components/schemas/V2UserPresence"},{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64","description":"The time, in milliseconds since Jan 1 1970, when the presence state was set."}}}]},"V2UserPresence":{"allOf":[{"$ref":"#/components/schemas/V2PresenceStatus"},{"type":"object","properties":{"userId":{"type":"integer","format":"int64","description":"The ID of the user to whom the presence state relates."}}}]},"V2PresenceStatus":{"type":"object","properties":{"category":{"type":"string","description":"Presence status. Possible values are:\n  - UNDEFINED\n  - AVAILABLE\n  - BUSY\n  - DO_NOT_DISTURB\n  - ON_THE_PHONE\n  - BE_RIGHT_BACK\n  - IN_A_MEETING\n  - AWAY\n  - OUT_OF_OFFICE\n  - OFF_WORK\n  - OFFLINE\n"}},"required":["category"]},"Error":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"}}}}}}
```

When calling this as an [OBO-enabled endpoint](https://rest-api.symphony.com/main/apps-on-behalf-of-obo), use the [OBO User Authenticate](https://rest-api.symphony.com/main/apps-on-behalf-of-obo/obo-rsa-user-authentication-by-user-id) token for `sessionToken`.

The available online status values (presence categories) for users are:

| Presence category | Interface icon   | External view   | Comment             |
| ----------------- | ---------------- | --------------- | ------------------- |
| `AVAILABLE`       | Green check mark | `AVAILABLE`     | Released in 1.46    |
| `AWAY`            | Yellow clock     | `AWAY`          | Released in 1.46    |
| `OFFLINE`         | Grey cross       | `OFFLINE`       | Introduced in 20.16 |
| `BUSY`            | Red sign         | `BUSY`          | Released in 1.46    |
| `ON_THE_PHONE`    | Red phone        | `ON_THE_PHONE`  | Released in 1.46    |
| `BE_RIGHT_BACK`   | Yellow clock     | `AWAY`          | Released in 1.47    |
| `IN_A_MEETING`    | Red phone        | `IN_A_MEETING`  | Released in 1.47    |
| `OUT_OF_OFFICE`   | Purple circle    | `OUT_OF_OFFICE` | Released in 1.47    |
| `OFF_WORK`        | Yellow clock     | `OFFLINE`       | Deprecated in 20.16 |
| `DO_NOT_DISTURB`  | Red circle       | `AWAY`          | Deprecated in 20.16 |

See [Set Presence](https://rest-api.symphony.com/main/presence/set-presence) for a description of the **Presence category** and **External view** values for internal and external users.

**Note**: It is also possible for Symphony users to have other presence values, which should be handled in your implementation as edge cases.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://rest-api.symphony.com/main/presence/get-presence.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.