---
title: "Get login status of current session"
method: GET
path: "/login"
tags: ["Authentication"]
---

# Get login status of current session

`GET /login`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/login`
- Auth: none required
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/login/get.ts> (a function with typed inputs; its response is checked against the schema)

Get login status of current session.

## Response `200`

OK

- object
  - `access_token` string: Access token to be passed as a header
  - `expires_at` string, date_time: The expiration date of the access token in RFC 3339 format, for example, ```2017-07-21T17:32:28Z```. The RFC 3339 format is defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)
  - `expires_in` integer: The number of seconds that the access token will be valid.
  - `role` string: Roles include built-in roles and custom roles. Built-in roles roles cannot be modified. Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion. Built-in roles include: - `SystemAdmin`: the system administrator has almost all permissions. - `Replicator`: the application permissions collection. - `Dealer`: the sales manager has all sold tenant resource permissions - `Admin`: the admin has all tenant-wide resource permissions. - `StandardUser`: the user all user-wide resource permissions. - `StandardInternationalUser`: the user all user-wide resource permissions with international call permissions. - `QueueManager`: The call queue manager.

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)