List Sales Targets

Beta

GET/v1/sales/account-users/{id}/sales-targets

This endpoint is idempotent. Learn more

Returns the revenue goals set for one sales rep, most recent period first.

This endpoint does not support cursor pagination; passing a cursor returns a validation error, and the response carries no page cursors. Requesting targets for someone who is not an active account user in your account returns a not-found error.

Pass q to narrow the list to targets whose ID or goal amount contains the search text.

Permissions requiredValues:sales_targets:read

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

idstring

The account user (sales rep) whose targets to list.

Must be an active account user in your account.

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.

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 sales_target

Resources in this page.

idstring

Sales target ID.

objectstringenumValues:sales_target

Resource type identifier.

start_atstring (date-time)

Start of the period this target applies to (inclusive).

end_atstring (date-time)

End of the period this target applies to (e.g. the close of a quarter).

sales_repentitynullable

The sales rep this target is assigned to, referencing the account-user record the /v1/identity/account-users endpoints return.

A reference rather than the full record: it was tagged expandable but no include ever resolved it, so callers received an account user whose every field except the id was empty.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

amountquantitynullable

The revenue goal for the period, as a monetary quantity.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitunitnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

The dimension this unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

A quantity is converted with value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator), so a kilogram in a gram-based dimension has a numerator of 1000 and a denominator of 1.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

ownerownernullable

Owner of this resource.

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.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

The address billed by default on orders for this account.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Sales Targets

List Sales Targets

import OpenMRP from '@openmrp/sdk';

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

const listSalesTarget = await client.sales.accountUsers.salesTargets.list('acus_e5zu8bde0z3h');

console.log(listSalesTarget.data);

import OpenMRP from '@openmrp/sdk';

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

const listSalesTarget = await client.sales.accountUsers.salesTargets.list('acus_e5zu8bde0z3h');

console.log(listSalesTarget.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/account-users/acus_e5zu8bde0z3h/sales-targets?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoidGFfbjViNnNiZWZybWlpIiwiZCI6ImYifQ.g_cdC380b2eFU3cq6QG7oQ0Ic2UzhcEfxqxdcefX9OE",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ta_n5b6sbefrmii",
      "object": "sales_target",
      "start_at": "2026-05-10T00:00:00Z",
      "end_at": "2026-06-10T00:00:00Z",
      "sales_rep": {
        "id": "acus_e5zu8bde0z3h",
        "object": "entity",
        "type": "account_user",
        "name": null,
        "handle": null
      },
      "amount": {
        "id": "qty_8hnxbigf0bod",
        "object": "quantity",
        "value": "1234.56",
        "display_value": "$1,234.56",
        "unit": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/account-users/acus_e5zu8bde0z3h/sales-targets?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoidGFfbjViNnNiZWZybWlpIiwiZCI6ImYifQ.g_cdC380b2eFU3cq6QG7oQ0Ic2UzhcEfxqxdcefX9OE",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ta_n5b6sbefrmii",
      "object": "sales_target",
      "start_at": "2026-05-10T00:00:00Z",
      "end_at": "2026-06-10T00:00:00Z",
      "sales_rep": {
        "id": "acus_e5zu8bde0z3h",
        "object": "entity",
        "type": "account_user",
        "name": null,
        "handle": null
      },
      "amount": {
        "id": "qty_8hnxbigf0bod",
        "object": "quantity",
        "value": "1234.56",
        "display_value": "$1,234.56",
        "unit": null
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Sales Targets

Authorization

Path Parameters

Query Parameters

Returns

Responses