Team
Requires scope merchant-team-directory-read.
Lists the store’s staff directory — each member’s id, display name, role names and active flag — with cursor pagination (limit + starting_after, has_more/next_cursor). Contact details, credentials and permissions are never included.
Authorization
merchantKey The store's private API key (sk_live_…, sk_test_… on a dev store) from Dashboard → Settings → API keys. It is bound to one store and carries the scopes the merchant granted; each operation names the scope it needs. Server-side only — never ship it to a browser or an app bundle.
In: header
Query Parameters
1 <= value <= 100length <= 255Header Parameters
A private API key (sk_live_…, sk_test_… on a dev store) minted under Dashboard → Settings → API keys. The key is bound to ONE store, so no vendor header or vendor_id is sent; its scopes decide which operations it may call. pk_ public keys never reach this API. Keep it on your server.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/team-directory?limit=2" \ -H "X-Client-Key: {{merchantKey}}"{ "data": [ { "id": 109501, "name": "Amina Yusuf", "role_names": [ "Admin" ], "is_active": true }, { "id": 109502, "name": "Tunde Bakare", "role_names": [ "Manager" ], "is_active": false } ], "has_more": true, "next_cursor": "eyJpZCI6MTA5NTAyLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"}