List API Keys

Beta

GET/v1/auth/api-keys

This endpoint is idempotent. Learn more

Returns a paginated list of API keys, newest first.

Only keys belonging to the account making the request are returned. The search term matches against the key name.

Role type requiredValues:admin

Only API keys or agents whose role has this type can call this endpoint.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

statuses[]optional arrayenumValues:activeexpiredrevoked

API key statuses to filter by.

active: the key still authenticates requests. A key whose revocation is scheduled for a future time is still active until that time arrives.
expired: the key passed its expiration time without having been revoked.
revoked: the key was revoked, which takes precedence over expiration.

When omitted, keys of every status are returned.

include[]optional arrayenumValues:rolerole.permissions

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of api_key

Resources in this page.

idstring

API key ID.

objectstringenumValues:api_key

Resource type identifier.

namestring

Human-readable name for the API key.

redacted_valuestring

Redacted key value safe for display.

The key's prefix followed by its last four characters, e.g. mrp_sk_prod_****hjt4.

roleroleExpandablenullable

Role assigned to the key, which determines the permissions of requests made with it.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name of the role.

Unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The type gates behavior that individual permissions do not cover, and some actions are reserved for a single role type.

admin: full administrative access. Sensitive areas such as API keys, billing, and third-party integrations are restricted to admins no matter what permissions another role holds.
user: a custom role tailored to a specific need, with its permissions defined explicitly. Roles created through the API always have this type.
scanner: the role used by shop-floor scanning stations, assigned automatically when a scanning-station user is created.
sales_rep: a role for sales representatives. Order analytics are scoped to the rep's own orders.
agent: a role assigned to an automated agent rather than a person.

ownerownernullable

Provenance of this role.

System-owned roles are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned roles are custom to your account.

Always returned as null in this endpoint.

permissionsarray of stringExpandablenullable

Permissions granted by this role, in {permission}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

last_used_atstring (date-time)nullable

When the key was last used to authenticate a request.

Recorded at most once every 24 hours, so it can lag the key's most recent use by up to a day.

expires_atstring (date-time)nullable

When the key expires and stops authenticating requests.

A key with no expiration keeps working until it is revoked or rotated.

revoked_atstring (date-time)nullable

When the key's revocation takes effect.

A future timestamp means revocation was scheduled (for example, by a rotation) and the key continues to authenticate requests until that time.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List API Keys

List API Keys

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listAPIKey = await client.auth.apiKeys.list();

console.log(listAPIKey.data);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listAPIKey = await client.auth.apiKeys.list();

console.log(listAPIKey.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/auth/api-keys?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJpIjo5MDAwMDAwMDAwMDAwMDAxLCJkIjoiZiJ9.kXKAISCnBjRSQgFnd0I7qTeh0r-BDb_Nuc5YPrCvj9U",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "apke_eiylmwr6q7oz",
      "object": "api_key",
      "name": "Production API Key",
      "redacted_value": "mrp_sk_prod_****hjt4",
      "role": {
        "id": "rl_3xknmfqflhvb",
        "object": "role",
        "name": "Admin",
        "type": "admin",
        "owner": null,
        "permissions": [
          "customers:create",
          "customers:read",
          "customers:update",
          "customers:delete"
        ],
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "last_used_at": "2026-05-10T00:23:00Z",
      "expires_at": "2026-06-10T00:00:00Z",
      "revoked_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/auth/api-keys?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJpIjo5MDAwMDAwMDAwMDAwMDAxLCJkIjoiZiJ9.kXKAISCnBjRSQgFnd0I7qTeh0r-BDb_Nuc5YPrCvj9U",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "apke_eiylmwr6q7oz",
      "object": "api_key",
      "name": "Production API Key",
      "redacted_value": "mrp_sk_prod_****hjt4",
      "role": {
        "id": "rl_3xknmfqflhvb",
        "object": "role",
        "name": "Admin",
        "type": "admin",
        "owner": null,
        "permissions": [
          "customers:create",
          "customers:read",
          "customers:update",
          "customers:delete"
        ],
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "last_used_at": "2026-05-10T00:23:00Z",
      "expires_at": "2026-06-10T00:00:00Z",
      "revoked_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List API Keys

Authorization

Query Parameters

Returns

Responses