Skip to main content
GET
Read a member by id

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

object | null

Successful response

id
string
required
custom_id
string | null
required
name
string | null
required
createdAt
string
required
updatedAt
string
required
allowances
object[]
required
allowance_type_configurations
object[]
required
allowance_type_configurtaions
object[]
required

DEPRECATED: Use allowance_type_configurations instead

approval_process
enum<string>
required
Available options:
Linear_all_have_to_agree,
Linear_one_has_to_agree,
Parallel_all_have_to_agree,
Parallel_one_has_to_agree
status
enum<string>
required
Available options:
INACTIVE,
ACTIVE,
ARCHIVED
birthday
string | null
required
employment_start_date
string | null
required
employment_end_date
string | null
required
email
string | null
required
departments
object[]
required
is_admin
boolean
required
has_approvers
object[]
required
approver_config
object
required
schedules
object[]
required