Members
List Members
Lists Members
Authorization
HTTPBearer AuthorizationBearer <token>
In: header
Query Parameters
search?|
Search members by name, email, phone, external ID, or short_id.
group_id?array<>|
Return only members with an active membership in one or more groups. Provide the parameter multiple times for multiple groups.
product_id?array<>|
Return only members on a non-canceled, non-expired subscription for one or more products. Provide the parameter multiple times for multiple products.
status?array<>|
Filter by member status. Omit to return only active members. Provide the parameter multiple times for multiple statuses.
page?integer
Page number
Default
1Range
1 <= valuesize?integer
Page size
Default
50Range
1 <= value <= 100Header Parameters
Members-Context?|
Members organization id (org_…) when the client has multiple organizations.
Response Body
application/json
application/json
curl -X GET "https://api.members.dev/v1/members"{
"items": [
{
"id": "member_01KKSMB47VYGW97GFE67VGDK7M",
"short_id": "XF42",
"name": "John Doe",
"external_id": "ext_abc123",
"emails": [
{
"id": "member_email_01KKSMB47VYGW97GFE67VGDK7M",
"email": "user@example.com",
"is_default": true,
"is_verified": true
}
],
"addresses": [
{
"id": "member_address_01KKSMB47VYGW97GFE67VGDK7M",
"recipient_name": "string",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"administrative_area": "string",
"postal_code": "string",
"country_code": "string",
"is_default": true
}
],
"phones": [
{
"id": "member_phone_01KKSMB47VYGW97GFE67VGDK7M",
"number": "string",
"country_code": "string",
"is_default": true
}
],
"subscriptions": [
{
"id": "string",
"product": {
"product_id": "string"
}
}
],
"group_ids": [
"string"
],
"custom_fields": {},
"account_id": "string",
"status": "draft",
"pass": {
"id": "string",
"share_url": "string"
},
"created_at": null,
"updated_at": null
}
],
"total": 0,
"page": 1,
"size": 1,
"pages": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}