Show/hide List Operations Expand Operations

Flatapi

The flat API is the synchronisation surface for the mobile and factory applications. A device sends a bookmark timestamp per entity type and receives only what changed since each one, so it can be current on workers and stale on workdones at the same time. These endpoints log a device in by password, by PIN, NFC or RFID credential, or by factory provisioning, and load the company data set it needs afterwards. Mutation requests let a device push records it created offline, with its own UUIDs. This is the busiest surface in the API by call volume.

GET /api/flatapi/company-worker-by-device-uuid

Resolves the company-level worker a device authenticates as

Documentation
Sandbox

Documentation

Returns resolves the company-level worker a device authenticates as, by device uuid and company api key.

Parameters

Parameter	Type	Required?	Description
device_uuid	string	true	Device UUID the company-level worker is resolved for.
company_apikey	string	true	Company-level api key the device authenticates with.
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (flatapi, auth). 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
is_active_mobile	boolean	*
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)	*
classificator	string	*
reversed_fullname	string	*
division	object (Department)	*
company	object (Company)	*	Object owner
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
password_md5	string	*	Worker password md5 hash
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
apikey	string	*	Workers Api key
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
gps_required	boolean	*	True if GPS in mobile is required
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	*
created_at_timestamp	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/flatapi/credential-login

Logs a worker in with a PIN, NFC or RFID credential and the company api key

Documentation
Sandbox

Documentation

Parameters

Parameter	Type	Required?	Description
company_apikey	string	true	Company-level api key the device authenticates with.
credential	string	true	PIN, NFC or RFID credential identifying the worker.
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (flatapi, auth). 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
is_active_mobile	boolean	*
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)	*
classificator	string	*
reversed_fullname	string	*
division	object (Department)	*
company	object (Company)	*	Object owner
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
password_md5	string	*	Worker password md5 hash
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
apikey	string	*	Workers Api key
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
gps_required	boolean	*	True if GPS in mobile is required
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	*
created_at_timestamp	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/flatapi/credential-login

Logs a worker in with a PIN, NFC or RFID credential and the company api key

Documentation
Sandbox

Documentation

Parameters

Parameter	Type	Required?	Format	Description
company_apikey	string	true		Company-level api key the device authenticates with.
credential	string	true		PIN, NFC or RFID credential identifying the worker.

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
is_active_mobile	boolean	*
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)	*
classificator	string	*
reversed_fullname	string	*
division	object (Department)	*
company	object (Company)	*	Object owner
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
password_md5	string	*	Worker password md5 hash
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
apikey	string	*	Workers Api key
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
gps_required	boolean	*	True if GPS in mobile is required
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	*
created_at_timestamp	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST DEPRECATED /api/flatapi/credentials

Documentation
Sandbox

Documentation

Login user with Factory Credentials. Returns the device's company data set, or an empty worker object when the credentials are not accepted

Parameters

Parameter	Type	Required?	Description
pin	string	false	Query parameter pin
target_worker_uuid	string	false	Query parameter target_worker_uuid
version	string	false	Query parameter version

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/flatapi/factory-initial-login

First login of a factory-provisioned device, before the worker has credentials

Documentation
Sandbox

Documentation

First login of a factory-provisioned device, before the worker has credentials. Returns a keyed set - LoggedWorker, CompanyWorker, Worker, WorkerFactoryCredentials and Workdone - not a single entity. The same action answers on GET and POST.

Parameters

Parameter	Type	Required?	Description
username	string	true	Username
password	string	true	Password
email	string	false	E-mail address used as the username.
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (flatapi, auth). 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.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/flatapi/factory-initial-login

First login of a factory-provisioned device, before the worker has credentials

Documentation
Sandbox

Documentation

Parameters

Parameter	Type	Required?	Description
username	string	true	Username
password	string	true	Password
email	string	false	E-mail address used as the username.

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/flatapi/load-company-data

Loads the company data set a device needs after logging in

Documentation
Sandbox

Documentation

Handles loads the company data set a device needs after logging in. The same action answers on GET and POST.

Parameters

Parameter	Type	Required?	Format	Description
version	integer	false		Client build number, recorded against the device.
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (flatapi). 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
is_active_mobile	boolean	*
roles_array	array	*	Worker app / My Profile uses this
rolestring	string	*	Workfields app uses this for everything
department_obj	object (Department)	*
classificator	string	*
reversed_fullname	string	*
company	object (Company)	*	Object owner
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
password_md5	string	*	Worker password md5 hash
facility	object (Facility)	*	Workers main facility
apikey	string	*	Workers Api key
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
gps_required	boolean	*	True if GPS in mobile is required
created_at_timestamp	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/flatapi/load-company-data

Loads the company data set a device needs after logging in

Documentation
Sandbox

Documentation

Handles loads the company data set a device needs after logging in. The same action answers on GET and POST.

Parameters

Parameter	Type	Required?	Format	Description
version	integer	false		Client build number, recorded against the device.

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
is_active_mobile	boolean	*
roles_array	array	*	Worker app / My Profile uses this
rolestring	string	*	Workfields app uses this for everything
department_obj	object (Department)	*
classificator	string	*
reversed_fullname	string	*
company	object (Company)	*	Object owner
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
password_md5	string	*	Worker password md5 hash
facility	object (Facility)	*	Workers main facility
apikey	string	*	Workers Api key
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
gps_required	boolean	*	True if GPS in mobile is required
created_at_timestamp	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/flatapi/login

Logs a worker in with username and password

Documentation
Sandbox

Documentation

Handles logs a worker in with username and password

Parameters

Parameter	Type	Required?	Format	Description
username	string	true		Username
password	string	true		Password

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
is_active_mobile	boolean	*
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)	*
classificator	string	*
reversed_fullname	string	*
division	object (Department)	*
company	object (Company)	*	Object owner
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
password_md5	string	*	Worker password md5 hash
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
apikey	string	*	Workers Api key
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
gps_required	boolean	*	True if GPS in mobile is required
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	*
created_at_timestamp	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/flatapi/mutationrequest

Create new MutationRequest

Documentation
Sandbox

Documentation

Creates new MutationRequest. Returns the created or modified objects, keyed by entity name; an empty array when nothing applied

Parameters

Parameter	Type	Required?	Description
uuid	string	false	Mutation Request UUID
target_entity_name	string	true	target entity name, can be one of following: CostAccount \| Customer \| DeviceLocation \| Facility \| Faultitem \| Fileitem \| FolderLayout \| FuelFilling \| InspectionCase \| InspectionCaseItem \| JourneyForm \| JourneyFormItem \| Material \| MaterialUsage \| MaterialUsageAdding \| Notification \| Project \| Planitem \| SignedDocument \| SilageTransport \| TransportCase \| Workdone \| WorkerProperties \| Workobject \| Worktype
target_entity_uuid	string	true	Mutating target object UUID
request_content	string	true	String containing Mutating object JSON. When creating new object, mandatory parameters are required. When mutating existing object, only modified parameters must be present.
worker	json	true	Worker Object
created_at_timestamp	int	true	Object creation unix timestamp (UTC)
is_mobile_originated	boolean	false
device_uuid	string	true	Mobile Device (application host device) UUID
version	integer	false	Client build number, recorded against the device.

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/flatapi/objects

Flat-structured objects for client data access

Documentation
Sandbox

Documentation

Flat-structured objects for client data access. Send per-entity bookmarks as t[EntityName]=timestamp and the client receives only what changed since each, so a device syncs every entity type on its own clock. include_entities narrows which types are returned. Returns the changed objects per entity type, or an empty worker object when the api key is not accepted

Parameters

Parameter	Type	Required?	Description
timestamp	integer	true	Records updated from Unix timestamp
device_type	integer	false	Calling client: 0 workfields, 1 factory.
include_entities	string	false	Comma-separated entity names to include in the response.
language	string	false	Two-letter language code for translated labels. Defaults to et.
ongoing_ids	string	false	Comma-separated ids of records already open on the device.
simplify_tolerance	float	false	Geometry simplification tolerance in degrees.
t	array	false	Per-entity last-update timestamps, sent as t[entity]=timestamp.
version	integer	false	Client build number, recorded against the device.
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (flatapi). 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.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/flatapi/reject-todoitem

Rejects Rosteritem or Planitem

Documentation
Sandbox

Documentation

Rejects Rosteritem or Planitem. Returns an array of objects with: Rosteritem, Planitem. The same action answers on GET and POST.

Parameters

Parameter	Type	Required?	Description
item_type	string	true	Type of the to-do item being rejected.
item_uuid	string	true	Uuid of the to-do item being rejected.
version	integer	false	Client build number, recorded against the device.
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (flatapi). 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.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/flatapi/reject-todoitem

Rejects Rosteritem or Planitem

Documentation
Sandbox

Documentation

Rejects Rosteritem or Planitem. Returns an array of objects with: Rosteritem, Planitem. The same action answers on GET and POST.

Parameters

Parameter	Type	Required?	Description
item_type	string	true	Type of the to-do item being rejected.
item_uuid	string	true	Uuid of the to-do item being rejected.
version	integer	false	Client build number, recorded against the device.

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/flatapi/take-todoitem

Takes a to-do item (Rosteritem or Planitem) for the calling worker

Documentation
Sandbox

Documentation

Takes a to-do item (Rosteritem or Planitem) for the calling worker. Returns an array of objects with: Rosteritem, Planitem. The same action answers on GET and POST.

Parameters

Parameter	Type	Required?	Description
item_type	string	true	Type of the to-do item being taken.
item_uuid	string	true	Uuid of the to-do item being taken.
version	integer	false	Client build number, recorded against the device.
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (flatapi). 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.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/flatapi/take-todoitem

Takes a to-do item (Rosteritem or Planitem) for the calling worker

Documentation
Sandbox

Documentation

Takes a to-do item (Rosteritem or Planitem) for the calling worker. Returns an array of objects with: Rosteritem, Planitem. The same action answers on GET and POST.

Parameters

Parameter	Type	Required?	Description
item_type	string	true	Type of the to-do item being taken.
item_uuid	string	true	Uuid of the to-do item being taken.
version	integer	false	Client build number, recorded against the device.

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/flatapi/upload-fileitem-content/{uuid}

Upload file

Documentation
Sandbox

Documentation

Uploads file. Returns the stored fileitem, or { error: message.file_too_big }

Requirements

Name	Requirement	Type	Description
uuid		integer\|string	Material uuid

Parameters

Parameter	Type	Required?	Description
version	integer	false	Client build number, recorded against the device.
file	file	false	File sent as a multipart upload, when content is not used.
content	string	true	File contents as a base64 data URI.
name	string	false	File name to store.

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/flatapi/worker-factory-credentials

Registers a PIN, NFC or RFID credential for a worker

Documentation
Sandbox

Documentation

Handles registers a PIN, NFC or RFID credential for a worker

Parameters

Parameter	Type	Required?	Description
nfc	string	false	NFC tag identifier to register for the worker.
rfid	string	false	RFID tag identifier to register for the worker.
pin	string	false	PIN code to register for the worker.
username	string	true	Username
password	string	true	Password

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
uuid	string	*
id	integer	*
worker	object (Worker)	*
factory_pin	string	*
factory_rfid	string	*
factory_nfc	string	*
updated_at_timestamp	integer	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v2/flatapi/objects

Flat-structured objects for client data access, version 2

Documentation
Sandbox

Documentation

Flat-structured objects for client data access, version 2. Send per-entity bookmarks as t[EntityName]=timestamp and the client receives only what changed since each. Returns the changed objects per entity type, or an empty worker object when the api key is not accepted

Parameters

Parameter	Type	Required?	Description
language	string	false	Query parameter language
ongoing_ids	string	false	Query parameter ongoing_ids
timestamp	string	false	Query parameter timestamp
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (flatapi-v2). 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.

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

Integrations

An Integration connects a company to an external telemetry or accounting partner - Wialon, John Deere, Mapon, Directo and others. It holds the credentials and the synchronisation bookmarks for that partner. These endpoints read and edit integration records and the partner objects mapped to Terake ones. Most of the traffic here is machine-to-machine with the standalone integration service rather than customer-facing. Mapping a partner object to a Terake object is what lets telemetry land on the right machine or field.

GET /api/directo-status/{integration_id}

Number of approved and not approved wordones in period, grouped by day

Documentation
Sandbox

Documentation

Number of approved and not approved wordones in period, grouped by day. Returns one row per sent file as { file_name, send_time, file_response_code, file_response }

Requirements

Name	Requirement	Type	Description
integration_id		integer\|string	Integration id

Parameters

Parameter	Type	Required?	Format	Description
from	string	false		Date as Y-m-d, for example 2026-08-28.
to	string	false		Date as Y-m-d, for example 2026-08-28.

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

GET /api/integration-facility-timeline

Returns a fixed demonstration timeline of facilities and fields

Documentation
Sandbox

Documentation

Returns Gobus drivers

Parameters

Parameter	Type	Required?	Format	Description
region_id	string	false		Query parameter region_id

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/integration-partner-bookmarks/{integration_partner_id}/{company_id}

Synchronization timestamps

Documentation
Sandbox

Documentation

Synchronization timestamps. Returns the partner synchronisation bookmarks, or { error: alert.not_allowed } when the caller may not read them

Requirements

Name	Requirement	Type	Description
integration_partner_id		integer\|string	IntegrationPartner id
company_id		integer\|string	Company id

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

GET /api/integration-partner-data/{terake_object_code}/{object_id}

Integration partner id's related to object

Documentation
Sandbox

Documentation

Integration partner id's related to object. Returns the partner ids linked to the object, with its latest telemetry as { kilometers, enginehours, measuring_time }

Requirements

Name	Requirement	Type	Description
object_id		integer\|string	Id of the Terake object, of the type named by object_type
terake_object_code

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (integration). 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.

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/integrations

Integration collection

Documentation
Sandbox

Documentation

Returns Integration 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 (integration, 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	*
integration_partner	object (IntegrationPartner)	*
apikey	string	*
secret	string	*
apiurl	string	*
representative	object (Worker)	*
created_at_timestamp	integer	*
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/integrations

Create new Integration

Documentation
Sandbox

Documentation

Creates new Integration

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".
apikey	string	false
secret	string	false
apiurl	string	false
integration_partner	object	false	Reference to IntegrationPartner. 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	*
integration_partner	object (IntegrationPartner)	*
apikey	string	*
secret	string	*
apiurl	string	*
representative	object (Worker)	*
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
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/integrations/{id}

Delete Integration by ID or UUID

Documentation
Sandbox

Documentation

Deletes Integration by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	Integration 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	*
integration_partner	object (IntegrationPartner)	*
apikey	string	*
secret	string	*
apiurl	string	*
representative	object (Worker)	*
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
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/integrations/{id}

Integration by ID or UUID

Documentation
Sandbox

Documentation

Returns Integration by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	Integration 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 (integration, baseattribute, auditcolumns). 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	*
integration_partner	object (IntegrationPartner)	*
apikey	string	*
secret	string	*
apiurl	string	*
representative	object (Worker)	*
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
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/integrations/{id}

Modifies Integration

Documentation
Sandbox

Documentation

Modifies Integration

Requirements

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

Parameters

Parameter	Type	Required?	Description
id	integer	true	Id of the record being updated. Must match the id in the URL.
apikey	string	false
secret	string	false
apiurl	string	false
integration_partner	object	false	Reference to IntegrationPartner. 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	*
integration_partner	object (IntegrationPartner)	*
apikey	string	*
secret	string	*
apiurl	string	*
representative	object (Worker)	*
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
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

GET /api/wialon-callback/{token}

Wialon callback

Documentation
Sandbox

Documentation

Wialon callback. Returns the callback result, or { error_slug: alert.incorrect_url } when the token is unknown

Requirements

Name	Requirement	Type	Description
token

Parameters

Parameter	Type	Required?	Description
access_token	string	false	Query parameter access_token
lang	string	false	Query parameter lang
wialon_sdk_url	string	false	Query parameter wialon_sdk_url
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (integration). 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.

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Terake API

Sync

Dates and times

Flatapi

GET /api/flatapi/company-worker-by-device-uuid

Documentation

Parameters

Headers

Return

200

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/flatapi/credential-login

Documentation

Parameters

Headers

Return

200

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/flatapi/credential-login

Documentation

Parameters

Headers

Return

200

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST DEPRECATED /api/flatapi/credentials

Documentation

Parameters

Headers

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/flatapi/factory-initial-login

Documentation

Parameters

Headers

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/flatapi/factory-initial-login

Documentation

Parameters

Headers

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/flatapi/load-company-data

Documentation

Parameters

Headers

Return

200

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]