Skip to main content
GET
/
v1
/
people
/
{id}
Get person by ID
curl --request GET \
  --url https://api.trycomp.ai/v1/people/{id} \
  --header 'X-API-Key: <api-key>'
{
  "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": "john.doe@company.com",
    "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

Path Parameters

​
id
string
required

Member ID

Example:

"mem_abc123def456"

Response

Person retrieved 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
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
required

FleetDM label ID for member devices

Example:

123

​
user
object
required

User information

​
backgroundCheckRequests
object[]

Background check requests for this member