Endpoint
List members
GET
/v1/team/membersIncludes pending invitations (status: "invited").
- Scope a restricted key needs
team:read- Publishable key
- Not allowed: secret or restricted key only
- Idempotency-Key
- Not used. A GET is already safe to repeat.
Parameters
| Parameter | Type and place | Meaning |
|---|---|---|
role | stringquery | Only members of this role. |
status | stringquery | invited, active or removed. |
limit | integerquery | Items per page, 1 to 100. Default 20. |
starting_after | stringquery | An object id: return the items after it. |
ending_before | stringquery | An object id: return the items before it. |
created[gte] | string (date-time)query | Created at or after. Also created[gt], created[lte], created[lt]. |
created[lt] | string (date-time)query | Created before. |
Orrerie-Version | stringheader | API version date. Default: the version the key was created with. Example 2026-10-11. |
Example request
curl
curl https://api.orrerie.com/v1/team/members \
-H "Authorization: Bearer $ORRERIE_SECRET_KEY"JavaScript
const response = await fetch("https://api.orrerie.com/v1/team/members", {
headers: {
Authorization: `Bearer ${process.env.ORRERIE_SECRET_KEY}`,
},
});
const result = await response.json();
if (!response.ok) throw new Error(`${result.error.code}: ${result.error.message}`);
console.log(result);Python
import os
import requests
response = requests.get(
"https://api.orrerie.com/v1/team/members",
headers={"Authorization": f"Bearer {os.environ['ORRERIE_SECRET_KEY']}"},
timeout=30,
)
result = response.json()
if not response.ok:
raise RuntimeError(f"{result['error']['code']}: {result['error']['message']}")
print(result)PHP
<?php
$request = curl_init('https://api.orrerie.com/v1/team/members');
curl_setopt_array($request, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('ORRERIE_SECRET_KEY'),
],
]);
$body = curl_exec($request);
if ($body === false) {
throw new RuntimeException(curl_error($request));
}
$result = json_decode($body, true);
if (curl_getinfo($request, CURLINFO_HTTP_CODE) >= 400) {
throw new RuntimeException($result['error']['code'] . ': ' . $result['error']['message']);
}
print_r($result);Responses
200 OK
A list whose data holds member objects. Headers: Orrerie-Request-Id.
Example response, 200
{
"object": "list",
"url": "/v1/team/members",
"has_more": false,
"data": [
{
"id": "mem_ceh1wpzdrpk13cnpcjy9w0fa",
"object": "member",
"livemode": true,
"created": "2026-09-02T09:15:44.020Z",
"user": "usr_yrwyak6zrppn5310bxms89nv",
"email": "owner@acme.example",
"name": "Sam Rivera",
"role": "owner",
"status": "active",
"holds_wallet_key": true,
"passkey_count": 2,
"invited_by": null,
"invitation_expires_at": null,
"last_active_at": "2026-10-12T09:00:00.000Z"
},
{
"id": "mem_re2bmvrnbzsbefcwx64ftp5w",
"object": "member",
"livemode": true,
"created": "2026-09-20T11:00:00.000Z",
"user": "usr_vhpdrdebjrkc46bb09vn6nbm",
"email": "till@acme.example",
"name": "Ana Lopez",
"role": "cashier",
"status": "active",
"holds_wallet_key": false,
"passkey_count": 1,
"invited_by": "mem_ceh1wpzdrpk13cnpcjy9w0fa",
"invitation_expires_at": null,
"last_active_at": "2026-10-12T09:00:00.000Z"
}
]
}Any other status: an error
A status of 400 or above answers with the error object. Branch on its code, never on its message.
Errors
This call has no error of its own. It answers with the errors every call can answer with: a bad key, a missing scope, an object that does not exist, the rate limit. Every error code has its own entry.