List Priorities

Beta

GET/v1/sales/priorities

This endpoint is idempotent. Learn more

Lists the priority levels that can be set on a sales order or purchase order.

The levels are platform-provided and the same for every account, so the result is small and stable enough to cache. Results are ordered newest first rather than by urgency.

Permissions requiredValues:priorities:read

The role behind your API key or agent must grant every one of these permissions.

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.

include[]optional arrayenumValues:owner

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 priority

Resources in this page.

idstring

Priority ID.

objectstringenumValues:priority

Resource type identifier.

codestringenumValues:lownormalhigh

Machine-readable code identifying the priority level.

Other resources refer to a priority by this code rather than by its ID, such as a sales order's priority, and it can be used in place of the ID when retrieving a priority.

namestring

Display name of the priority level.

ownerownerExpandablenullable

Owner of this resource.

Priorities are platform-provided and shared across all accounts, so the owner is always the OpenMRP system owner.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

system: a platform-provided default shared across all accounts; not editable.
account: created and owned by a specific account; the account field identifies which.

accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Priorities

List Priorities

import OpenMRP from '@openmrp/sdk';

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

const listPriority = await client.sales.priorities.list();

console.log(listPriority.data);

import OpenMRP from '@openmrp/sdk';

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

const listPriority = await client.sales.priorities.list();

console.log(listPriority.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/priorities?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoicGlfZHVia2JxcG56NDVmIiwiZCI6ImYifQ.T-P0BC2Qun_TjUA9f1P_g0170kG4LhPbU5baUcl_jxk",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "pi_dubkbqpnz45f",
      "object": "priority",
      "code": "normal",
      "name": "Normal",
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/priorities?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoicGlfZHVia2JxcG56NDVmIiwiZCI6ImYifQ.T-P0BC2Qun_TjUA9f1P_g0170kG4LhPbU5baUcl_jxk",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "pi_dubkbqpnz45f",
      "object": "priority",
      "code": "normal",
      "name": "Normal",
      "owner": {
        "object": "owner",
        "type": "system",
        "account": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Priorities

Authorization

Query Parameters

Returns

Responses