List Sales Targets
Beta/v1/sales/account-users/{id}/sales-targetsThis 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.
idstringThe account user (sales rep) whose targets to list.
Must be an active account user in your account.
cursoroptional stringOpaque 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 integerMaximum number of results to return in a single page.
qoptional stringFree-text search term used to filter results.
Which fields are matched against the term varies by endpoint.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableRelative URL that fetches the next page of results.
previous_page_urlstringnullableRelative URL that fetches the previous page of results.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of sales_targetResources in this page.
idstringSales target ID.
objectstringenumValues:sales_targetResource 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_repusernullableThe sales rep this target is assigned to.
This is the rep's account-user record, identified by the same ID the /v1/identity/account-users endpoints return. Only the id is populated.
idstringUser ID.
objectstringenumValues:userResource type identifier.
emailstringnullableEmail address the user signs in with and receives platform email at.
namestringnullableUser's full display name.
usernamestringnullableUsername the user can sign in with instead of their email address.
Usernames are unique across the whole platform, not just within your account.
email_verified_atstring (date-time)nullableWhen the user verified their email address.
image_urlstringnullableLocation of the user's profile image.
For photos uploaded through the API this holds an internal path rather than a fetchable image URL; call Get User Photo URL to obtain a temporary link to the image itself.
created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
amountquantitynullableThe revenue goal for the period, as a monetary quantity.
idstringQuantity ID.
objectstringenumValues:quantityResource 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_valuestringFormatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").
Unit of measure for this value (e.g. a currency, mass, or count unit).
idstringUnit ID.
objectstringenumValues:unitResource type identifier.
namestringDisplay name of the unit (e.g. "Gram", "Kilogram").
abbreviationstringShort abbreviation for the unit (e.g. "g", "kg").
typestringenumValues:currencyquantitytimeThe 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_unitbooleanWhether 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.
ownerownernullableOwner of this resource.
objectstringenumValues:ownerResource type identifier.
typestringenumValues:systemaccountWhere this resource came from.
system: a platform-provided default shared across all accounts; not editable.account: created and owned by a specific account; theaccountfield identifies which.
accountaccountnullableThe account that owns this resource.
Present only when type is account; system-owned resources have no owning account.
idstringAccount ID.
objectstringenumValues:accountResource type identifier.
namestringThe account's display name.
The address billed by default on orders for this account.
The address shipped to by default on orders for this account.
brandingaccount_brandingnullableCustomer-facing branding for the account, such as the logo, support contacts, and social links.
portalaccount_portalnullableThe 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
Successful response for List Sales Targets