Retrieve Priority

Beta

GET/v1/sales/priorities/{id}

This endpoint is idempotent. Learn more

Retrieves a single priority level by ID or by code.

Looking one up by code is usually more convenient, because other resources refer to a priority by code rather than by ID.

Permissions requiredValues:priorities:read

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

idstring

Priority ID or code.

Passing the code, such as normal, resolves the same priority as passing its generated ID.

include[]optional arrayenumValues:owner

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

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 Retrieve Priority

Retrieve Priority

import OpenMRP from '@openmrp/sdk';

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

const priority = await client.sales.priorities.retrieve('pi_dubkbqpnz45f');

console.log(priority.id);

import OpenMRP from '@openmrp/sdk';

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

const priority = await client.sales.priorities.retrieve('pi_dubkbqpnz45f');

console.log(priority.id);

200 example

{
  "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"
}

{
  "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"
}

Retrieve Priority

Authorization

Path Parameters

Query Parameters

Returns

Responses