Skip to main content
GET
/
v5
/
app
/
members
/
{id}
Retrieve a Member
curl --request GET \
  --url https://{defaultHost}/v5/app/members/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "company_id": "<string>",
  "user_id": "<string>",
  "status": "drafted",
  "most_recent_action": "canceling",
  "joined_at": 123,
  "user": {
    "id": "<string>",
    "name": "<string>",
    "username": "<string>",
    "email": "<string>",
    "profile_pic_url": "<string>",
    "created_at": 123,
    "profile_pic_url_32": "<string>",
    "profile_pic_url_64": "<string>",
    "profile_pic_url_128": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

App API key for /v5/app and /v5/company endpoints

Path Parameters

​
id
string
required

The ID of the Member, which will look like mber_*************.

Response

member found

​
id
string
required

The ID of the user, which will look like user_*************

​
company_id
string
required

The ID of the company, which will look like biz_*************

​
user_id
string
required

The ID of the user, which will look like user_*************

​
status
enum<string>
required

The status of the member

Available options:
drafted,
joined,
left
​
joined_at
integer
required

The date the member was created as a unix timestamp.

​
user
object
required
​
most_recent_action
enum<string> | null

The most recent action of the member

Available options:
canceling,
churned,
finished_split_pay,
paused,
paid_subscriber,
paid_once,
expiring,
joined,
drafted,
left,
trialing,
pending_entry,
renewing,
past_due