List Account Statuses
Beta/v1/sales/account-statusesThis endpoint is idempotent. Learn more
Returns a paginated list of account statuses. Global lookup values for setting account relationship statuses.
cursoroptional stringCursor token used to retrieve the next or previous page of results.
limitoptional integerMaximum number of results per page (default: 100, max: 1000).
qoptional stringSearch query used to filter results.
include[]optional arrayenumValues:ownerSub-objects to expand in the response. When omitted, sub-objects are returned as null.
objectstringenumValues:listResource type identifier.
page_infoobjectPagination metadata.
next_page_urlstringnullableURL to fetch the next page, null if no more pages.
previous_page_urlstringnullableURL to fetch the previous page, null if on the first page.
has_next_pagebooleanWhether more results exist after this page.
has_prev_pagebooleanWhether results exist before this page.
dataarray of objectResources in this page.
idstringAccount status ID.
objectstringenumValues:account_statusResource type identifier.
codestringenumValues:normalpreferredhold_shipmentMachine-readable status code.
namestringDisplay name.
ownerobjectExpandablenullableOwner of this resource.
objectstringenumValues:ownerResource type identifier.
typestringenumValues:systemaccountThe owner type: "system" for platform defaults, "account" for account-owned resources.
accountobjectnullableThe account that owns this resource. null if the object is system-owned.
null in this endpoint.created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
Responses
Successful response for List Account Statuses