Create a new member | Comp AI API

Adds a new member to the authenticated organization. The user must already exist in the system.

POST /v1/people

Create a new member

cURL

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"
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({userId: 'usr_abc123def456', role: 'admin'})
};

fetch('https://api.trycomp.ai/v1/people', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/people"

payload = {
    "userId": "usr_abc123def456",
    "role": "admin"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

201

{
  "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"
  }
}

{
  "message": "User [e-mail] is already a member of this organization"
}

{
  "message": "Unauthorized"
}

{
  "message": "User with ID usr_abc123def456 not found"
}

{
  "message": "Failed to create member"
}

Authorizations

X-API-Key · string · header · required

API key for authentication

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 (built-in role name or custom role ID)

Example:

"admin"

department · string

Member department. Built-in values: none, admin, gov, hr, it, itsm, qms. Custom department names are also accepted.

Maximum string length: 64

Example:

"it"

isActive · boolean

Whether member is active

Example:

true

fleetDmLabelId · number

FleetDM label ID for member devices

Example:

123

jobTitle · string

Job title for the member

Example:

"Software Engineer"

Response

201

application/json

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 · string · required

Member department. May be one of the built-in values (none, admin, gov, hr, it, itsm, qms) or a custom department name.

Example:

"it"

jobTitle · object | null · required

Job title for the member

Example:

"Software Engineer"

isActive · boolean · required

Whether member is active

Example:

true

deactivated · boolean · required

Whether member is deactivated

Example:

false

fleetDmLabelId · object | null · required

FleetDM label ID for member devices

Example:

123

user · object · required

User information

Show child attributes

backgroundCheckRequests · object[]

Background check requests for this member

Show child attributes