Skip to main content
GET
/
v1
/
members
/
{id}
Get Member
curl --request GET \
  --url https://api.spairehq.com/v1/members/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "email": "<string>",
  "name": "Jane Doe",
  "external_id": "usr_1337"
}

Documentation Index

Fetch the complete documentation index at: https://docs.spairehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

You can generate a Personal Access Token from your settings.

Path Parameters

​
id
string<uuid>
required

Response

Member retrieved.

A member of a customer.

​
id
string<uuid4>
required

The ID of the member.

​
created_at
string<date-time>
required

Creation timestamp of the object.

​
modified_at
string<date-time> | null
required

Last modification timestamp of the object.

​
customer_id
string<uuid4>
required

The ID of the customer this member belongs to.

​
email
string
required

The email address of the member.

Example:

"member@example.com"

​
name
string | null
required

The name of the member.

Example:

"Jane Doe"

​
external_id
string | null
required

The ID of the member in your system. This must be unique within the customer.

Example:

"usr_1337"

​
role
enum<string>
required

The role of the member within the customer.

Available options:
owner,
billing_manager,
member
Example:

"owner"