Get a customer's order counts and recent activity
AI agents: read /llms.txt; add .md to any page URL. This page as Markdown: /reference/customers/v1-customer-activity-summary.md. Index of every page and the rules for every call: /llms.txt. Guides and concepts in one file: /llms-full.txt. OpenAPI: /openapi.json.
GET/
Counts the customer's published sales orders, quotes and invoices, whatever their status (completed ones included), and lists its 10 newest sales orders and quotes.
counts.orders: published sales orders that are not deleted, in any status.counts.quotes: published quotes that are not deleted, in any status.counts.invoices: invoices that are not deleted, on those sales orders.recent_activity: the same sales orders and quotes, newest created first, at most 10, each withid,type(sales_orderorquote),number,status_name,created_atandtotal. With 10 or fewer, it hascounts.orders+counts.quotesrows.
Drafts are left out everywhere. For open work only, use the customer's totals instead (unpaid_amount, quote_amount).
Path parameters
Your team slug, shown as Team ID next to your API key in Profile.
- Example
your-team
- Example
The customer's id (
idfrom List customers) or the customer's unique key.- Example
EDhVUaC6jbLbed
- Example
Request body
This operation takes no request body.
Response
200Successful response.
Child fields (3)
Fields of each item (6)
The sales order or quote number people see, such as
SO1001.- One of:
"sales_order","quote"
- One of:
created_atstring (date-time) | nullstatus_namestring | nulltotalinteger | number | stringThe order total. Thousandths, an older encoding:
125000is 125.00. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5is 1.2345), or as a string ("1234.5") when you sendX-Yoprint-Decimal-Format: exact-v1. See Money and quantities.
Errors
401The API key is missing or wrong (
unauthenticated).403You are not allowed to do this.
api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only{"message": "Insufficient Permission"}. Other refusals use the error envelope, withunauthorizedoruser_is_not_authorized.- When
- Your role has no Manage Customers permission, or it manages only customers assigned to you and this one is not. This 403 has a short body,
{"message": "You do not have permission to view customer"}. - Fix
- Ask for Manage Customers "Manage All", or to be assigned to the customer.
404Not found.
page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's.code: null, with a message that starts "No query results for": there is no record with that id.- When
- No live, non-system customer with this id.
error.codeis null anderror.messagenames the record type. - Fix
- Check the id. Deleted customers have no summary.
Related
- GETGet a customer
/v1/ api/ store/ {team_slug}/ customer/ {hash_id}
