API reference · Members

Members and memberships

Create members and read their studio-specific profile and membership state.

Endpoints5

Primary objectMemberObject

Tenant boundaryCredential studio

GET/members

List members

Lists member, user, and lead-role profiles in the credential’s studio.

Required scope: members:read
Success: 200
Response: Page<MemberObject>

Parameters

cursorquery

uuid

Opaque cursor returned by the previous page. Pass it back unchanged.

limitquery

integer

Number of records to return. Defaults to 50; maximum 200.

Example request

curl -X GET "https://api.getclassflow.com/partner/v1/members" \
  -H "X-ClassFlow-Key: $CLASSFLOW_API_KEY"

Example response

200 · application/json

{
  "object": "list",
  "data": [{
    "id": "5fef0f5c-2165-48e0-a730-9c066eb37f9a",
    "object": "member",
    "name": "Randy Example",
    "first_name": "Randy",
    "last_name": "Example",
    "email": "randy@example.com",
    "role": "member",
    "membership_type": "intro",
    "created_at": "2026-08-02T20:41:00Z"
  }],
  "has_more": false,
  "next_cursor": null
}

POST/members

Create a member

Creates a member through ClassFlow’s canonical member service and studio RBAC checks.

Required scope: members:write
Success: 201
Response: MemberObject

Request body

Send a JSON object matching MemberCreate.

application/json

{
  "email": "randy@example.com",
  "first_name": "Randy",
  "last_name": "Example",
  "phone": "+13035550199"
}

Example request

curl -X POST "https://api.getclassflow.com/partner/v1/members" \
  -H "X-ClassFlow-Key: $CLASSFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "email": "randy@example.com",
  "first_name": "Randy",
  "last_name": "Example",
  "phone": "+13035550199"
}'

Example response

201 · application/json

{
  "id": "5fef0f5c-2165-48e0-a730-9c066eb37f9a",
  "object": "member",
  "name": "Randy Example",
  "first_name": "Randy",
  "last_name": "Example",
  "email": "randy@example.com",
  "role": "member",
  "membership_type": "intro",
  "created_at": "2026-08-02T20:41:00Z"
}

GET/members/{member_id}

Retrieve a member

Returns one member profile without private staff notes or payment credentials.

Required scope: members:read
Success: 200
Response: MemberObject

Parameters

member_idpathrequired

uuid

The stable ClassFlow identifier for the member.

Example request

curl -X GET "https://api.getclassflow.com/partner/v1/members/YOUR_MEMBER_ID" \
  -H "X-ClassFlow-Key: $CLASSFLOW_API_KEY"

Example response

200 · application/json

{
  "id": "5fef0f5c-2165-48e0-a730-9c066eb37f9a",
  "object": "member",
  "name": "Randy Example",
  "first_name": "Randy",
  "last_name": "Example",
  "email": "randy@example.com",
  "role": "member",
  "membership_type": "intro",
  "created_at": "2026-08-02T20:41:00Z"
}

GET/members/{member_id}/memberships

List a member’s memberships

Lists membership records owned by one member in the same studio.

Required scope: members:read
Success: 200
Response: Page<MembershipObject>

Parameters

member_idpathrequired

uuid

The stable ClassFlow identifier for the member.

Example request

curl -X GET "https://api.getclassflow.com/partner/v1/members/YOUR_MEMBER_ID/memberships" \
  -H "X-ClassFlow-Key: $CLASSFLOW_API_KEY"

Example response

200 · application/json

{
  "object": "list",
  "data": [{
    "id": "710ff631-30e6-40f5-bb45-5237230657c3",
    "object": "membership",
    "member_id": "5fef0f5c-2165-48e0-a730-9c066eb37f9a",
    "product_id": "7e3c7795-6be7-48c6-894e-cbbfb32c472d",
    "status": "active",
    "auto_renew": false,
    "state_version": 4
  }],
  "has_more": false,
  "next_cursor": null
}

GET/memberships/{membership_id}

Retrieve a membership

Returns status, renewal, pause, cancellation, and state-version data for one membership.

Required scope: members:read
Success: 200
Response: MembershipObject

Parameters

membership_idpathrequired

uuid

The stable ClassFlow identifier for the membership.

Example request

curl -X GET "https://api.getclassflow.com/partner/v1/memberships/YOUR_MEMBERSHIP_ID" \
  -H "X-ClassFlow-Key: $CLASSFLOW_API_KEY"

Example response

200 · application/json

{
  "id": "710ff631-30e6-40f5-bb45-5237230657c3",
  "object": "membership",
  "member_id": "5fef0f5c-2165-48e0-a730-9c066eb37f9a",
  "product_id": "7e3c7795-6be7-48c6-894e-cbbfb32c472d",
  "status": "active",
  "auto_renew": false,
  "state_version": 4
}

Object schema

MemberObject

Full OpenAPI schema

iduuid

Stable member identifier.

emailemail | null

Member email.

membership_typestring | null

Current member classification.

membership_start_datedate-time | null

Current membership start date when available.

membership_end_datedate-time | null

Current membership end date when available.