> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get User Presence Status

> Get user presence status

<para />## Online Restricted: ## The User agent is not available in Online by default. User management is not allowed for partner apps.



## OpenAPI

````yaml /openapi/rest/openapi-v3-User.json get /api/v1/User/{associateId}/UserPresenceStatus
openapi: 3.0.0
info:
  version: v1-REST
  title: SuperOffice REST API v1
  description: SuperOffice REST API - User
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/User/{associateId}/UserPresenceStatus:
    get:
      tags:
        - User
      summary: Get User Presence Status
      description: >-
        Get user presence status


        <para />## Online Restricted: ## The User agent is not available in
        Online by default. User management is not allowed for partner apps.
      operationId: v1User_GetUserPresenceStatus
      parameters:
        - name: associateId
          in: path
          description: AssociateId of user to retrieve status for.
          required: true
          schema:
            format: int32
            type: integer
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.UserPresenceStatus
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.UserPresenceStatus
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.UserPresenceStatus
            text/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.UserPresenceStatus
            application/json-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.UserPresenceStatus
            application/merge-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.UserPresenceStatus
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.UserPresenceStatus:
      description: "Manage present/absent status for a Service user account (influences ticket assignments).\r\n<para />\r\nCarrier object for UserPresenceStatus.\r\nServices for the UserPresenceStatus Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IUserAgent\">User Agent</see>."
      type: object
      properties:
        Status:
          description: The status (enum) for this user.
          enum:
            - StatusNone
            - StatusNormal
            - StatusNotAvailable
            - StatusDeleted
            - StatusReadOnly
            - StatusSpm
            - StatusSystem
          type: string
        Message:
          description: Comment to add for user when status is not present.
          type: string

````

## Related topics

- [Get User Presence Status](/en/api/reference/restful/agent/user_agent/get-user-presence-status.md)
- [SuperOffice.WebApi.Data.User GetUserPresenceStatusRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.User_GetUserPresenceStatusRequest.md)
- [SuperOffice.WebApi.Agents.UserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.UserAgent.md)
- [SuperOffice.WebApi.Agents.IUserAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IUserAgent.md)
- [Set User Presence Status](/en/api/reference/restful/agent/user_agent/set-user-presence-status.md)