Sessions

Endpoints that target a user's running Qonic app session. List the running sessions with `GET /v1/sessions`, then pass a session ID as the `X-Client-Session-Id` header on the session-bound endpoints to reach that app instance.

GET https://api.qonic.com/v1/sessions

List running Qonic app sessions

Returns the Qonic app sessions the authenticated user currently has running, ordered by most recent activity first. Each session corresponds to an instance of the Qonic app (e.g. a browser tab or desktop window) and carries the project and models currently opened in it. Use a session's id as the X-Client-Session-Id header to target a specific session on endpoints that interact with a running Qonic app.

Response fields

  • Name
    sessions
    Type
    array<object>
    Required
    Optional
    Description
    Sessions the user currently has running, ordered by most recent activity first.
    • Name
      id
      Type
      string
      Required
      Optional
      Description
      Opaque identifier used to target this session via the X-Client-Session-Id header.
    • Name
      platform
      Type
      string
      Required
      Optional
      Description
      The platform the Qonic app is running on (e.g. Web, Windows, macOS, iOS, Android).
    • Name
      projectId
      Type
      integer
      Required
      Optional
      Description
      The ID of the project currently opened in the session, if any.
    • Name
      projectName
      Type
      string
      Required
      Optional
      Description
      The name of the project currently opened in the session, if any.
    • Name
      models
      Type
      array<object>
      Required
      Optional
      Description
      The models currently opened in the session.
      • Name
        id
        Type
        integer
        Required
        Optional
        Description
        Numeric identifier of the model within the project (the decimal model id used elsewhere in the API).
      • Name
        guid
        Type
        string
        Required
        Optional
        Description
        Globally unique identifier of the model.
      • Name
        name
        Type
        string
        Required
        Optional
        Description
        Display name of the model as shown in the app.
      • Name
        canCreateProducts
        Type
        boolean
        Required
        Optional
        Description
        Whether the authenticated user can create geometry-backed products in this model.
      • Name
        canModifyData
        Type
        boolean
        Required
        Optional
        Description
        Whether the authenticated user can modify data in this model.
    • Name
      lastActiveAt
      Type
      string
      Required
      Optional
      Description
      UTC timestamp of the last keep-alive ping from the session.

Error responses

  • Name
    401
    Type
    application/problem+json
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.

    Body: ProblemDetails

  • Name
    403
    Type
    application/problem+json
    Description
    Insufficient permissions for this operation

    Body: ProblemDetails

‹
Previous
Auth API
›
Next
Codifications