TRtrycompai
People

Get person by ID

Changed on

Returns a specific member by ID for the authenticated organization with their user information.

get/v1/people/{id}

Request

  • Base URL
    https://api.trycomp.ai
  • Auth
    API key in header X-API-Key

Path parameters

idstring required
Example:mem_abc123def456

Member ID

Response

Person retrieved successfully

idstring required

Member ID

organizationIdstring required

Organization ID this member belongs to

userIdstring required

User ID associated with member

rolestring required

Member role

createdAtstring date-time required

When the member was created

departmentstring required

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

jobTitleobject nullable required

Job title for the member

isActiveboolean required

Whether member is active

deactivatedboolean required

Whether member is deactivated

fleetDmLabelIdobject nullable required

FleetDM label ID for member devices

Example response

{
  "id": "mem_abc123def456",
  "organizationId": "org_abc123def456",
  "userId": "usr_abc123def456",
  "role": "admin",
  "createdAt": "2024-01-01T00:00:00Z",
  "department": "it",
  "isActive": true,
  "user": {
    "id": "usr_abc123def456",
    "name": "John Doe",
    "email": "john.doe@company.com",
    "emailVerified": true,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-15T00:00:00Z"
  },
  "backgroundCheckRequests": [
    {
      "id": "bcr_abc123def456",
      "status": "invited"
    }
  ]
}

Changes

  • 33c685841b7aRevision changes
    • info

      removed the admin enum value from the response property for the response status

    • info

      removed the gov enum value from the response property for the response status

    • info

      removed the hr enum value from the response property for the response status

    • info

      removed the it enum value from the response property for the response status

    • info

      removed the itsm enum value from the response property for the response status

    • info

      removed the none enum value from the response property for the response status

    • info

      removed the qms enum value from the response property for the response status

  • 7ca7c363a732Revision changes
    • warning

      added the new admin enum value to the response property for the response status

    • warning

      added the new gov enum value to the response property for the response status

    • warning

      added the new hr enum value to the response property for the response status

    • warning

      added the new it enum value to the response property for the response status

    • warning

      added the new itsm enum value to the response property for the response status

    • warning

      added the new none enum value to the response property for the response status

    • warning

      added the new qms enum value to the response property for the response status