COcortex
Users

List users

Changed on

Returns every user in your Cortex tenant along with their profile metadata: name, email, join date, and last active timestamp. Intended for access reviews, compliance, and auditing. Role assignments are available from the separate GET /api/v1/users/roles endpoint. Requires the View Roles permission; assign it to a custom role to issue a least-privilege API key for automated reporting.

get/api/v1/users

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/users
  • Auth
    HTTP bearer

Query parameters

emailstring[]

Filter to specific users by email. Provide a comma-separated list to request multiple users (e.g. ?email=a@acme.com,b@acme.com). Matching is case-insensitive. Omit to return all users.

pageSizeinteger required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger required

Page number to return, 0-indexed. Default 0.

Response

Successfully retrieved users

pageinteger required

Current page number, 0-indexed

totalinteger required

Total number of results

totalPagesinteger required

Total number of pages

Example response

{
  "users": [
    {
      "joinedAt": "2024-01-15T08:00:00Z",
      "lastActiveAt": "2024-06-10T14:45:00Z"
    }
  ]
}

Changes

  • a7b058663c95Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status