Skip to main content
POST
/
v1
/
people
Create a new member
curl --request POST \
  --url https://api.trycomp.ai/v1/people \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "userId": "usr_abc123def456",
  "role": "admin",
  "department": "it",
  "isActive": true,
  "fleetDmLabelId": 123
}'
{
  "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": "[email protected]",
    "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"
  }
}

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)

Body

application/json

Member creation data

​
userId
string
required

User ID to associate with this member

Example:

"usr_abc123def456"

​
role
string
required

Role for the member

Example:

"admin"

​
department
enum<string>

Member department

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

"it"

​
isActive
boolean

Whether member is active

Example:

true

​
fleetDmLabelId
number

FleetDM label ID for member devices

Example:

123

Response

Member created successfully

​
id
string
required

Member ID

Example:

"mem_abc123def456"

​
organizationId
string
required

Organization ID this member belongs to

Example:

"org_abc123def456"

​
userId
string
required

User ID associated with member

Example:

"usr_abc123def456"

​
role
string
required

Member role

Example:

"admin"

​
createdAt
string<date-time>
required

When the member was created

Example:

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

​
department
enum<string>
required

Member department

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

"it"

​
isActive
boolean
required

Whether member is active

Example:

true

​
fleetDmLabelId
object | null
required

FleetDM label ID for member devices

Example:

123

​
user
object
required

User information