chat.users.availability.get
Retrieves the authenticated user's Google Chat availability, including online or away state and custom status message, to check current presence before messaging.
Instructions
Returns availability information for a human user in Google Chat. For example, this can be used to check if a user is online or away, or to retrieve their custom status message. This method only retrieves the authenticated user's availability. Requires user authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.users.availability.readonly - https://www.googleapis.com/auth/chat.us [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the paramsmap), or read whole frombody_file` Siblings over the same resource: markAsActive, markAsAway, markAsDoNotDisturb, patch.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | [URL path segment] Required. The resource name of the availability to retrieve. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK | |
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| state | No | ||
| customStatus | No | ||
| doNotDisturbMetadata | No |