Get all people

Returns all members for the authenticated organization with their user information. Supports both API key authentication (X-API-Key header) and session authentication (cookies + X-Organization-Id header).

GET /v1/people

Try it

Get all people

cURL

curl --request GET \
  --url http://localhost:3333/v1/people \
  --header 'X-API-Key: <api-key>'

200

{
  "data": [
    {
      "id": "mem_abc123def456",
      "organizationId": "org_abc123def456",
      "userId": "usr_abc123def456",
      "role": "admin",
      "createdAt": "2024-01-01T00:00:00Z",
      "department": "it",
      "isActive": true,
      "fleetDmLabelId": 123,
      "user": {
        "id": "usr_abc123def456",
        "name": "John Doe",
        "email": "[e-mail]",
        "emailVerified": true,
        "image": "https://example.com/avatar.jpg",
        "createdAt": "2024-01-01T00:00:00Z",
        "updatedAt": "2024-01-15T00:00:00Z",
        "lastLogin": "2024-01-15T12:00:00Z"
      }
    }
  ],
  "count": 1,
  "authType": "api-key",
  "authenticatedUser": {
    "id": "usr_abc123def456",
    "email": "[e-mail]"
  }
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Headers

X-Organization-Id · string

Organization ID (required for session auth, optional for API key auth)

Response

200

application/json

People retrieved successfully

data · object[]

Show child attributes

data. id · string · required

Member ID

Example:

"mem_abc123def456"

data. organizationId · string · required

Organization ID this member belongs to

Example:

"org_abc123def456"

data. userId · string · required

User ID associated with member

Example:

"usr_abc123def456"

data. role · string · required

Member role

Example:

"admin"

data. createdAt · string<date-time> · required

When the member was created

Example:

"2024-01-01T00:00:00Z"

data. department · enum<string> · required

Member department

Available options: none, admin, gov, hr, it, itsm, qms

Example:

"it"

data. isActive · boolean · required

Whether member is active

Example:

true

data. fleetDmLabelId · object · required

FleetDM label ID for member devices

Example:

123

data. user · object · required

User information

Show child attributes

data.user. id · string · required

User ID

Example:

"usr_abc123def456"

data.user. name · string · required

User name

Example:

"John Doe"

data.user. email · string · required

User email

Example:

"[e-mail]"

data.user. emailVerified · boolean · required

Whether email is verified

Example:

true

data.user. image · object · required

User profile image URL

Example:

"https://example.com/avatar.jpg"

data.user. createdAt · string<date-time> · required

When the user was created

Example:

"2024-01-01T00:00:00Z"

data.user. updatedAt · string<date-time> · required

When the user was last updated

Example:

"2024-01-15T00:00:00Z"

data.user. lastLogin · object · required

Last login time

Example:

"2024-01-15T12:00:00Z"

count · number

Total number of people

Example:

25

authType · enum<string>

How the request was authenticated

Available options: api-key, session

authenticatedUser · object

Show child attributes

authenticatedUser. id · string

User ID

Example:

"usr_abc123def456"

authenticatedUser. email · string

User email

Example:

"[e-mail]"