Skip to main content
GET
/
members
List organization members
curl --request GET \
  --url https://alfaone.app/api/v1/members \
  --header 'x-api-key: <api-key>'
{
  "members": [
    {
      "id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com",
      "avatarUrl": "<string>",
      "roles": [],
      "department": "<string>",
      "joinedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 87,
    "totalPages": 5
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Format: ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Query Parameters

​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
limit
integer
default:20

Number of items per page (max 100)

Required range: 1 <= x <= 100
​
sort
enum<string>
default:joined_at

Field to sort by

Available options:
joined_at,
email
​
order
enum<string>
default:desc

Sort direction

Available options:
asc,
desc

Response

Successful response

​
members
object[]
​
pagination
object