Skip to main content
GET
/
v2
/
members
List members
curl --request GET \
  --url https://api.campsite.com/v2/members \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "role": "admin",
      "created_at": "<string>",
      "is_deactivated": true,
      "user": {
        "id": "<string>",
        "avatar_urls": {
          "xs": "<string>",
          "sm": "<string>",
          "base": "<string>",
          "lg": "<string>",
          "xl": "<string>",
          "xxl": "<string>"
        },
        "email": "<string>",
        "display_name": "<string>"
      }
    }
  ],
  "total_count": 123,
  "next_cursor": "<string>",
  "prev_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
q
string

Search by name or email.

​
after
string

Use with next_cursor and prev_cursor in the response to paginate through results.

​
limit
number

Specifies how many records to return. The default and maximum is 50.

​
roles
enum<string>

Filter by role. Separate multiple roles with commas.

Available options:
admin,
member,
viewer,
guest
​
sort
enum<string>
Available options:
created_at,
last_seen_at
​
direction
enum<string>
Available options:
asc,
desc

Response

200 - application/json

Successful operation

​
data
object[]
required
​
total_count
number
required
​
next_cursor
string | null
​
prev_cursor
string | null