List staff members
The store’s team, newest member first: who is a member, what role each one holds, and whether that membership is active. THIS IS WHAT RESOLVES THE USER IDS THIS API ALREADY HANDS YOU. assigned_to on a conversation and author_user_id on a message are store user ids and nothing else published here could turn one into a person, so an inbox rendering a thread showed a raw identifier. Sync this list once and you can name every actor in it. THE id IS THE USER ID, not a membership id. It is the same value assigned_to carries, the same value the conversation PUT accepts back, and it is stable across stores, because one person can be on more than one team. SUSPENDED AND INVITED MEMBERS ARE INCLUDED. Their ids still appear on conversations and messages you already hold, so hiding them would answer “no such member” for somebody plainly named on the thread you are rendering. Read status before you assign NEW work: only active grants access, so assigning to a suspended member gives it to someone who cannot log in to see it. first_name and last_name are BEST EFFORT and may be null. They come from a second lookup outside the membership record, and a failure there degrades to an unnamed member rather than failing the roster, so the id is always right and the name may be absent. Do not key anything on the name. NO EMAIL ADDRESS IS PUBLISHED. Every consumer of this resource takes a user id, and the address is additionally the input the merchant’s own team-invite uses, so serving it here would make this grant a staff mailing list ranked by role. If you need to reach a teammate, do it through the merchant rather than through this API. NO FILTERS. A team is tens of rows, role and status arrive on every one of them, and a query parameter cannot be withdrawn once you have written against it. THIS FAMILY IS READ ONLY and there is no write half to add later. The role field is not an attribute of this resource, it IS the resource, so a write would promote a member, demote an owner, or suspend the one person able to undo either, from a key already acting inside the store. apiscope mints no write_staff at all. Team changes stay in the dashboard, where a human owner makes them.
Authorizations
A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.
Query Parameters
Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.
1 <= x <= 100The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.