List Members

Returns a collection of members

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

company_id

string

An ID of a company to filter by, which will look like biz_*************

user_id

string

An ID of a user to filter by, which will look like user_*************

status

enum<string>

A status to filter by.

Available options:

joined,

left

experience_id

string

An ID of an experience to filter by, which will look like exp_*************. If private, the member must have a valid membership on a product that grants them access to the experience. If public, the user must be a member of the company.

search

string

A search to filter by. This will search the member's name and username.

page

integer

default:

1

The page number to retrieve

per

integer

default:

10

The number of resources to return per page. There is a limit of 50 results per page.

Response

200 - application/json

data

object[]

required

Show child attributes

data.company_id

string

required

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

data.id

string

required

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

data.joined_at

number

required

The date the member was created as a unix timestamp.

data.status

enum<string>

required

The status of the member

Available options:

joined,

left,

drafted

data.most_recent_action

string

The most recent action of the member

data.user

object

Show child attributes

data.user.created_at

number

required

The date the user was created as a unix timestamp.

data.user.id

string

required

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

data.user.username

string

required

The username of the user

data.user.email

string

The email of the user

data.user.name

string

The first and last name of the user.

data.user.profile_pic_url

string

The URL of the user's profile picture

data.user.profile_pic_url_128

string

The URL of the user's profile picture at 128x128 pixels

data.user.profile_pic_url_32

string

The URL of the user's profile picture at 32x32 pixels

data.user.profile_pic_url_64

string

The URL of the user's profile picture at 64x64 pixels

data.user_id

string

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

pagination

object

required

Show child attributes

pagination.current_page

number

required

Current page number

pagination.next_page

number

required

Next page number

pagination.prev_page

number

required

Previous page number

pagination.total_count

number

required

Total number of records

pagination.total_pages

number

required

Total number of pages