Show/hide List Operations Expand Operations

Auth

Authentication in this API is by api key, sent in the X-Terake-Api-Key header. The key identifies both the worker and their company, so it is the tenant boundary as much as the credential. These endpoints log a worker in with a username and password or through a Google or Facebook account, validate a key, and issue one-time tokens for links sent by email. Registration creates a company and its first account together. Password reset works by emailing a link that carries a token rather than by sending a password.

GET /api/changecompany/{target_company_id}

Switches the authenticated worker to another of their allowed companies.

Documentation
Sandbox

Documentation

Switches the authenticated worker to another of their allowed companies.

Requirements

Name	Requirement	Type	Description
target_company_id		integer\|string	Company id to switch the caller to

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (auth, auth_user). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
allowed_companies	array	*
role_ids	array	*
privileges	array	*
roles_array	array	*	Worker app / My Profile uses this
rolestring	string	*	Workfields app uses this for everything
department_obj	object (Department)	*
reversed_fullname	string	*
division	object (Department)	*
id	integer	*	Worker Id in Terake
firstname	string	*	Worker first name(s) (given names), Utf8 string 255 chars
lastname	string	*	Worker last name(s) (family names), Utf8 string 255 chars
fullname	string	*	Worker all name(s) separated by space, Utf8 string 255 chars
username	string	*	Worker username, auto-generated by Terake
rolecollection[]	array of objects (Role)	*
apikey	string	*	Workers Api key
user	object (User)	*
roster_visibility	object (RosterVisibility)	*	Roster Visibility type
start_time	DateTime	*
stop_time	DateTime	*
workplaces[]	array of objects (Workplace)	*
is_personal_code_verified	boolean	*
department	object (Department)	*	Department
company	object (Company)	*	Object owner

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/createclient

Create new client

Documentation
Sandbox

Documentation

Creates new client. Returns { status, key, loggedUser }, or an error slug when registration fails

Parameters

Parameter	Type	Required?	Description
fullname	string	true	Full name of the person registering. Split into first and last name.
country	string	false	Two-letter country code. Defaults to XX when omitted.
auth_provider	string	false	External identity provider, e.g. google or facebook.
auth_provider_id	string	false	Account id at the external provider.
auth_provider_token	string	false	Token issued by the external provider, verified before the account is created.
auth_provider_payload	object	false	Raw profile payload returned by the external provider.
company_regnum	string	false	Company Registration number
company_name	string	true	Company Name
email	string	true	Future admin user e-mail, it will be also username
password	string	false	Future admin user password
locale	string	true	Country 2 letter iso code

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/externalvalidator/{provider}/{token}

Validates a Google or Facebook token with the provider and returns the account data it

Documentation
Sandbox

Documentation

Validates a Google or Facebook token with the provider and returns the account data it vouches for

Requirements

Name	Requirement	Type	Description
provider
token

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/generate-token

Issues a one-time token

Documentation
Sandbox

Documentation

Issues a one-time token. Pass token_type in the URL to choose which kind. Returns the token as a bare string in the response body, not as JSON

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/generate-token/{token_type}

Issues a one-time token

Documentation
Sandbox

Documentation

Issues a one-time token. Pass token_type in the URL to choose which kind. Returns the token as a bare string in the response body, not as JSON

Requirements

Name	Requirement	Type	Description
token_type

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/login

Validates the api key and returns the Worker it belongs to

Documentation
Sandbox

Documentation

Validates the api key and returns the Worker it belongs to

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
allowed_companies	array	*
role_ids	array	*
privileges	array	*
roles_array	array	*	Worker app / My Profile uses this
rolestring	string	*	Workfields app uses this for everything
department_obj	object (Department)	*
reversed_fullname	string	*
division	object (Department)	*
id	integer	*	Worker Id in Terake
firstname	string	*	Worker first name(s) (given names), Utf8 string 255 chars
lastname	string	*	Worker last name(s) (family names), Utf8 string 255 chars
fullname	string	*	Worker all name(s) separated by space, Utf8 string 255 chars
username	string	*	Worker username, auto-generated by Terake
rolecollection[]	array of objects (Role)	*
apikey	string	*	Workers Api key
user	object (User)	*
roster_visibility	object (RosterVisibility)	*	Roster Visibility type
start_time	DateTime	*
stop_time	DateTime	*
workplaces[]	array of objects (Workplace)	*
is_personal_code_verified	boolean	*
department	object (Department)	*	Department
company	object (Company)	*	Object owner

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/login/{provider}

Logs a user in with a username and password, or with a Google or Facebook account

Documentation
Sandbox

Documentation

Logs a user in with a username and password, or with a Google or Facebook account. Returns the logged-in Worker, or the registration state for a flow that is not finished

Requirements

Name	Requirement	Type	Description
provider

Parameters

Parameter	Type	Required?	Description
email	string	false	E-mail identifying the account. Used with password, or to continue a registration
password	string	false	Account password
password2	string	false	Password repeated, when the step sets a new one
token	string	false	Token from the identity provider, or from a registration e-mail
step	string	false	Which step of the login or registration flow to run

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/sendpasswordlink

Sends a password reset link to the user e-mail

Documentation
Sandbox

Documentation

Sends a password reset link to the user e-mail. Returns the string ok

Parameters

Parameter	Type	Required?	Format	Description
email	string	true		E-mail the reset link is sent to
lng	string	false		Two-letter language code for the message

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/updatepassword

Sets a new password using the token from a password reset link

Documentation
Sandbox

Documentation

Sets a new password using the token from a password reset link. Returns the string ok

Parameters

Parameter	Type	Required?	Description
token	string	true	Token from the password reset link
password	string	true	New password
password2	string	true	New password repeated

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Departments

A Department is an organisational unit that also acts as a visibility boundary. Workers, facilities, fields, worktypes, customers and roster items can all be filtered by the caller's department as well as by their company. These endpoints create and edit departments and set which workers belong to one. Assigning a worker to a department narrows what they see rather than only labelling them. Records outside a worker's departments are simply absent from their responses.

GET /api/departments

Department collection

Documentation
Sandbox

Documentation

Returns Department collection

Parameters

Parameter	Type	Required?	Description
is_archived	boolean	false	Truthy returns archived records instead of active ones.
archived	boolean	false	Alias of is_archived; either being truthy has the same effect.
from_updated_at	integer	false	Records updated from Unix timestamp
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (department_list, classificator, baseattribute, archive). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
id	integer	*
name	string	*
outer_id	string	*
is_division	boolean	*
created_at_timestamp	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department
company	object (Company)	*	Object owner

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/departments

Create new Department

Documentation
Sandbox

Documentation

Creates new Department

Parameters

Parameter	Type	Required?	Description
id	integer	false	Updates this record instead of creating one, when given.
uuid	string	false	Updates the record with this uuid instead of creating one, when given. Clients that create records offline supply their own.
import_type	string	false	Set to "file" to match an existing record on outer_id, id or uuid before creating - used by the import endpoints.
outer_id	string	false	Identifier in the source system.
name	string	false
is_division	boolean	false
department	object	false	Reference to Department. Send { "id": <id> }, or null to clear.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
id	integer	*
name	string	*
outer_id	string	*
is_division	boolean	*
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department
company	object (Company)	*	Object owner

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/departments/{id}

Delete Department by ID or UUID

Documentation
Sandbox

Documentation

Deletes Department by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	Department id or uuid

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
id	integer	*
name	string	*
outer_id	string	*
is_division	boolean	*
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department
company	object (Company)	*	Object owner

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/departments/{id}

Department by ID or UUID

Documentation
Sandbox

Documentation

Returns Department by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	Department id or uuid

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		Look the record up by uuid instead of the id in the path.
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (department, classificator, baseattribute, auditcolumns, archive). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
id	integer	*
name	string	*
outer_id	string	*
is_division	boolean	*
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department
company	object (Company)	*	Object owner

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/departments/{id}

Modifies Department

Documentation
Sandbox

Documentation

Modifies Department

Requirements

Name	Requirement	Type	Description
id		integer\|string	Department id or uuid

Parameters

Parameter	Type	Required?	Description
id	integer	true	Id of the record being updated. Must match the id in the URL.
name	string	false
outer_id	string	false	Identifier in the source system.
is_division	boolean	false
department	object	false	Reference to Department. Send { "id": <id> }, or null to clear.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
id	integer	*
name	string	*
outer_id	string	*
is_division	boolean	*
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department
company	object (Company)	*	Object owner

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/departments/{id}/setworkers

Assigns the Department named in the URL to the listed Workers

Documentation
Sandbox

Documentation

Assigns the Department named in the URL to the listed Workers. Returns { success: true }

Requirements

Name	Requirement	Type	Description
id		integer\|string	Department id or uuid

Parameters

Parameter	Type	Required?	Format	Description
worker_id_array	array of integers	true		Workers assigned to the department. Replaces the whole list.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Professions

A Profession is a worker's trade or job title - driver, agronomist, mechanic. Workers reference one, and it can drive what work they are offered. These endpoints create, edit, archive and delete professions. The list is shared with partner companies and archived in two levels. Deleting is soft so existing workers keep a readable profession.

GET /api/professions

Profession collection

Documentation
Sandbox

Documentation

Returns Profession collection

Parameters

Parameter	Type	Required?	Description
is_archived	boolean	false	Truthy returns archived records instead of active ones.
archived	boolean	false	Alias of is_archived; either being truthy has the same effect.
from_updated_at	integer	false	Records updated from Unix timestamp
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (archive, profession, owner, baseattribute). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
id	integer	*
name	string	*
slug	string	*
archives[]	array of objects (ProfessionArchive)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
company	object (Company)	*	Object owner

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/professions

Create new Profession

Documentation
Sandbox

Documentation

Creates new Profession

Parameters

Parameter	Type	Required?	Description
id	integer	false	Updates this record instead of creating one, when given.
uuid	string	false	Updates the record with this uuid instead of creating one, when given. Clients that create records offline supply their own.
import_type	string	false	Set to "file" to match an existing record on outer_id, id or uuid before creating - used by the import endpoints.
outer_id	string	false	Identifier in the source system. Matched against first when import_type is "file".
name	string	false

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
id	integer	*
name	string	*
slug	string	*
archives[]	array of objects (ProfessionArchive)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
company	object (Company)	*	Object owner

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/professions/{id}

Delete Profession by ID or UUID

Documentation
Sandbox

Documentation

Deletes Profession by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	Profession id or uuid

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
id	integer	*
name	string	*
slug	string	*
archives[]	array of objects (ProfessionArchive)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
company	object (Company)	*	Object owner

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/professions/{id}

Profession by ID or UUID

Documentation
Sandbox

Documentation

Returns Profession by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	Profession id or uuid

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		Look the record up by uuid instead of the id in the path.
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (archive, profession, owner, baseattribute). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
id	integer	*
name	string	*
slug	string	*
archives[]	array of objects (ProfessionArchive)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
company	object (Company)	*	Object owner

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/professions/{id}

Modify Profession

Documentation
Sandbox

Documentation

Modifies Profession

Requirements

Name	Requirement	Type	Description
id		integer\|string	Profession id or uuid

Parameters

Parameter	Type	Required?	Format	Description
id	integer	true		Id of the record being updated. Must match the id in the URL.
name	string	false

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
id	integer	*
name	string	*
slug	string	*
archives[]	array of objects (ProfessionArchive)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
company	object (Company)	*	Object owner

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/professions/{id}/togglearchive

Toggle Archive/Un-archive Profession

Documentation
Sandbox

Documentation

Toggles Archive/Un-archive Profession. Does not have a request body.

Requirements

Name	Requirement	Type	Description
id		integer\|string	Profession id or uuid

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions	Description
200
id	integer	*
name	string	*
slug	string	*
archives[]	array of objects (ProfessionArchive)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
company	object (Company)	*	Object owner

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

WorkerGroups

A worker group is a set of workers handled together - a crew, a team, a brigade. Groups are used to roster, filter and report on several people at once. These endpoints create and edit groups and add or remove members. Deleting a group detaches its members rather than deleting them. Groups cut across departments, so a worker can be in a group without changing what they can see.

GET /api/worker_groups

All WorkerGroups list

Documentation
Sandbox

Documentation

List of WorkerGroups

Parameters

Parameter	Type	Required?	Description
is_archived	boolean	false	Truthy returns archived records instead of active ones.
archived	boolean	false	Alias of is_archived; either being truthy has the same effect.
from_updated_at	integer	false	Records updated from Unix timestamp.
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (workergrouplist). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions
200
worker_ids	array	*
id	integer	*
name	string	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/worker_groups

Creates or modifies a WorkerGroup

Documentation
Sandbox

Documentation

Creates new WorkerGroup

Requirements

Name	Requirement	Type	Description
id		integer\|string	WorkerGroup id or uuid. Only when modifying an existing record; leave it out to create a new one.

Parameters

Parameter	Type	Required?	Description
id	integer	false	Updates this record instead of creating one, when given.
uuid	string	false	Updates the record with this uuid instead of creating one, when given. Clients that create records offline supply their own.
import_type	string	false	Set to "file" to match an existing record on outer_id, id or uuid before creating - used by the import endpoints.
outer_id	string	false	Identifier in the source system. Matched against first when import_type is "file".
name	string	false
worker_ids	array of integers	false	Full member list of the group. Workers already in the group but not listed here are removed.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions
200
worker_ids	array	*
id	integer	*
name	string	*
workers[]	array of objects (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/worker_groups/{id}

Delete WorkerGroup

Documentation
Sandbox

Documentation

Deletes WorkerGroup by ID or UUID

Requirements

Name	Requirement	Type	Description
id	\d+	integer	WorkerGroup id

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		WorkerGroup uuid

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions
200
worker_ids	array	*
id	integer	*
name	string	*
workers[]	array of objects (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/worker_groups/{id}

Get WorkerGroup

Documentation
Sandbox

Documentation

Returns WorkerGroup by ID or UUID

Requirements

Name	Requirement	Type	Description
id	\d+	integer	WorkerGroup id

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		WorkerGroup uuid
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (workergroup, baseattribute). Narrows the response to those groups, dropping the nested objects the others add; a group not offered here is refused with 400.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions
200
worker_ids	array	*
id	integer	*
name	string	*
workers[]	array of objects (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/worker_groups/{id}

Creates or modifies a WorkerGroup

Documentation
Sandbox

Documentation

Creates new WorkerGroup

Requirements

Name	Requirement	Type	Description
id		integer\|string	WorkerGroup id or uuid. Only when modifying an existing record; leave it out to create a new one.

Parameters

Parameter	Type	Required?	Description
id	integer	true	Id of the record being updated. Must match the id in the URL.
name	string	false
worker_ids	array of integers	false	Full member list of the group. Workers already in the group but not listed here are removed.

Headers

Name	Required?	Description
X-Terake-Api-Key	false	Worker or token api key. The preferred way to authenticate; send this or the apikey query parameter.

Return

Parameter	Type	Versions
200
worker_ids	array	*
id	integer	*
name	string	*
workers[]	array of objects (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Terake API

Identity

Dates and times

Auth

GET /api/changecompany/{target_company_id}

Documentation

Requirements

Parameters

Headers

Return

200

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/createclient

Documentation

Parameters

Headers

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/externalvalidator/{provider}/{token}

Documentation

Requirements

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/generate-token

Documentation

Headers

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/generate-token/{token_type}

Documentation

Requirements

Headers

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/login

Documentation

Headers

Return

200

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/login/{provider}

Documentation

Requirements

Parameters

Headers

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/sendpasswordlink

Documentation

Parameters