Skip to main content
GET
Get an employee

Authorizations

Authorization
string
header
required

Access token from POST /oauth/token.

Path Parameters

id
string<uuid>
required

Response

Employee returned.

A person in your workspace and their onboarding progress.

email
string

Email address.

Example:

"alice@example.com"

endContractDate
string<date>

Contract end date. Left out when unknown.

Example:

"2026-12-31T00:00:00.000Z"

groupId
string<uuid>

The id of the employee's group (see GET /v1/groups). Left out when the employee has no group.

Example:

"9b2d4f6a-1c3e-4a5b-8d7f-0e1a2b3c4d5e"

groupName
string

Name of the employee's group. Left out when the employee has no group.

Example:

"Engineering"

id
string<uuid>

The employee's id (UUID).

Example:

"3f1c9a2e-94b1-4d72-a7d8-123456789abc"

name
string

Full name.

Example:

"Alice Doe"

onboardingStatus
enum<string>

Onboarding status, computed from the employee's tasks in this workspace the same way as on the People page in Secfix. NOT_APPLICABLE for a terminated employee or one with no applicable tasks. If the employee belongs to more than one workspace, the People page currently also counts tasks from the other workspaces, so the two can differ.

Available options:
COMPLETE,
INCOMPLETE,
ONGOING,
NOT_APPLICABLE
Example:

"ONGOING"

source
enum<string>

Where the record comes from.

Available options:
GOOGLE_WORKSPACE,
MANUAL,
MS_OFFICE365,
RETOOL,
HRIS
Example:

"GOOGLE_WORKSPACE"

startContractDate
string<date>

Contract start date. Left out when unknown.

Example:

"2025-01-15T00:00:00.000Z"

status
enum<string>

Employment status. TERMINATED once the employee is archived or deleted in Secfix.

Available options:
ACTIVE,
TERMINATED
Example:

"ACTIVE"

tasksSummary
object

Onboarding progress by task category, and the employee's tasks.