Documents & contracts

What is on file for an employee, and what has been issued to them. The files themselves are never exposed — only whether they exist, whether anyone has verified them, and when they were issued.

List document types

GET/v1/document_types

Query parameters

Name	Type	Required	Description
limit	integer	No	Page size. Values above 100 are clamped.
starting_after	string	No	Opaque cursor from a previous response’s next_cursor.
updated_since	timestamp	No	Return records changed at or after this instant. Tracks the record itself, not its child collections.
code	string	No	Look up one type by its code.

Responses

Status	Meaning
200	A page of document types.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
429	Rate limit exceeded. See the RateLimit-* headers.

Retrieve a document type

GET/v1/document_types/{id}

Path parameters

Name	Type	Required	Description
id	string	Yes	The identifier returned as id on the object.

Responses

Status	Meaning
200	The document type.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
404	No such document type in this workspace.
429	Rate limit exceeded. See the RateLimit-* headers.

List employee documents

GET/v1/employee_documents

Query parameters

Name	Type	Required	Description
limit	integer	No	Page size. Values above 100 are clamped.
starting_after	string	No	Opaque cursor from a previous response’s next_cursor.
updated_since	timestamp	No	Return records changed at or after this instant. Tracks the record itself, not its child collections.
employee_id	string	No	Only records for this employee.
document_type_id	string	No	Only documents of this type.
verification_status	string	No	pending, verified, or rejected.

Responses

Status	Meaning
200	A page of employee documents.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
429	Rate limit exceeded. See the RateLimit-* headers.

Retrieve an employee document

GET/v1/employee_documents/{id}

Path parameters

Name	Type	Required	Description
id	string	Yes	The identifier returned as id on the object.

Responses

Status	Meaning
200	The employee document.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
404	No such employee document in this workspace.
429	Rate limit exceeded. See the RateLimit-* headers.

List contracts

GET/v1/contracts

Query parameters

Name	Type	Required	Description
limit	integer	No	Page size. Values above 100 are clamped.
starting_after	string	No	Opaque cursor from a previous response’s next_cursor.
updated_since	timestamp	No	Return records changed at or after this instant. Tracks the record itself, not its child collections.
employee_id	string	No	Only records for this employee.
status	string	No	Only contracts in this state.
type	string	No	Only contracts of this kind.
start_date_from	date	No	Inclusive lower bound on the contract start date.
start_date_to	date	No	Inclusive upper bound — the named day is included.
end_date_from	date	No	Inclusive lower bound on the contract end date.
end_date_to	date	No	Inclusive upper bound — the named day is included.

Responses

Status	Meaning
200	A page of contracts.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
429	Rate limit exceeded. See the RateLimit-* headers.

Retrieve a contract

GET/v1/contracts/{id}

Path parameters

Name	Type	Required	Description
id	string	Yes	The identifier returned as id on the object.

Responses

Status	Meaning
200	The contract.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
404	No such contract in this workspace.
429	Rate limit exceeded. See the RateLimit-* headers.

List hr letters

GET/v1/hr_letters

Query parameters

Name	Type	Required	Description
limit	integer	No	Page size. Values above 100 are clamped.
starting_after	string	No	Opaque cursor from a previous response’s next_cursor.
employee_id	string	No	Only records for this employee.
letter_type	string	No	Only letters of this kind.
reference_number	string	No	Look up one letter by its reference.
issued_date_from	date	No	Inclusive lower bound on the issue date.
issued_date_to	date	No	Inclusive upper bound — the named day is included.

Responses

Status	Meaning
200	A page of hr letters.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
429	Rate limit exceeded. See the RateLimit-* headers.

Retrieve a hr letter

GET/v1/hr_letters/{id}

Path parameters

Name	Type	Required	Description
id	string	Yes	The identifier returned as id on the object.

Responses

Status	Meaning
200	The hr letter.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
404	No such hr letter in this workspace.
429	Rate limit exceeded. See the RateLimit-* headers.

List hr letter requests

GET/v1/hr_letter_requests

Query parameters

Name	Type	Required	Description
limit	integer	No	Page size. Values above 100 are clamped.
starting_after	string	No	Opaque cursor from a previous response’s next_cursor.
updated_since	timestamp	No	Return records changed at or after this instant. Tracks the record itself, not its child collections.
employee_id	string	No	Only records for this employee.
letter_type	string	No	Only requests for this kind of letter.
status	string	No	Only requests in this state.

Responses

Status	Meaning
200	A page of hr letter requests.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
429	Rate limit exceeded. See the RateLimit-* headers.

Retrieve a hr letter request

GET/v1/hr_letter_requests/{id}

Path parameters

Name	Type	Required	Description
id	string	Yes	The identifier returned as id on the object.

Responses

Status	Meaning
200	The hr letter request.
401	The API key is missing, malformed, revoked or expired.
403	The key does not carry the required scopes.
404	No such hr letter request in this workspace.
429	Rate limit exceeded. See the RateLimit-* headers.