Show/hide List Operations Expand Operations

Agreements

An Agreement records the contractual basis on which a field is farmed - a lease, an ownership record or a service arrangement. Agreement objects link the agreement to the fields and cadastral units it covers. These endpoints create and edit agreements, archive them and list the agreements attached to one workobject. Agreements matter for PRIA reporting, where the right to farm a field has to be evidenced. Archived agreements stay readable so past seasons still reconcile.

POST /api/agreements

Create new Agreement

Documentation
Sandbox

Documentation

Creates new Agreement

Parameters

Parameter	Type	Required?	Format	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".
agreement_number	string	false
description	string	false
signing_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value stores the current time. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
from_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value stores the current time. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
to_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value stores the current time. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
agreement_type	object	false		Reference to AgreementType. Send { "id": <id> }, or null to clear.
customer	object	false		Reference to Customer. Send { "id": <id> }, or null to clear.
customer_person	object	false		Reference to CustomerPerson. Send { "id": <id> }, or null to clear.
agreement	object	false		Relate the given workobject and cadastre to this existing agreement instead of creating a new one. Object with an id field.
workobject	object	false		Workobject to attach to the agreement named in agreement. Object with an id field.
cadastre	object	false		Cadastre linking the workobject to the agreement. Required whenever workobject is sent - it is read without a guard.
agreement_objects	array of objects	false		Agreement objects to create for a newly created agreement. Each entry has the same shape as workobject plus cadastre.
agreement_payment_detail	object	false		Payment details for the agreement. Read only when creating a new agreement, i.e. when agreement is not sent; omitting it then removes any payment detail the agreement already has.

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	*
fullname	string	*	Computed field
agreement_number	string	*	Agreement number
agreement_type	object (AgreementType)	*
signing_time	DateTime	*	agreement signing Time
from_time	DateTime	*	Effect start date
to_time	DateTime	*	Effect end date
customer	object (Customer)	*	Partner/Customer
customer_person	object (CustomerPerson)	*	Partner/Customer contact person
description	string	*
workobjects[]	array of objects (Agrifield)	*
agreement_objects[]	array of objects (AgreementObject)	*
agreement_payment_detail	object (AgreementPaymentDetail)	*
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

GET /api/agreements/agrifield

Agreements collection

Documentation
Sandbox

Documentation

Agreements collection. Returns the agreement objects of the company, ordered by agreement then cadastre number then field

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (agreement, baseattribute, search). 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/agreements/workobject/{workobject_id}

Agreements attached to one workobject

Documentation
Sandbox

Documentation

Agreements attached to one workobject. Returns the agreement objects attached to the workobject, and an empty array when there are none

Requirements

Name	Requirement	Type	Description
workobject_id		integer\|string	Workobject id

Parameters

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

DELETE /api/agreements/{id}

Delete Agreement by ID or UUID

Documentation
Sandbox

Documentation

Deletes Agreement by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	Agreement 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	*
fullname	string	*	Computed field
agreement_number	string	*	Agreement number
agreement_type	object (AgreementType)	*
signing_time	DateTime	*	agreement signing Time
from_time	DateTime	*	Effect start date
to_time	DateTime	*	Effect end date
customer	object (Customer)	*	Partner/Customer
customer_person	object (CustomerPerson)	*	Partner/Customer contact person
description	string	*
workobjects[]	array of objects (Agrifield)	*
agreement_objects[]	array of objects (AgreementObject)	*
agreement_payment_detail	object (AgreementPaymentDetail)	*
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
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/agreements/{id}

Agreement by ID or UUID

Documentation
Sandbox

Documentation

Returns Agreement by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	Agreement 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 (agreement, archive, classificator, auditcolumns, search). 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	*
fullname	string	*	Computed field
agreement_number	string	*	Agreement number
agreement_type	object (AgreementType)	*
signing_time	DateTime	*	agreement signing Time
from_time	DateTime	*	Effect start date
to_time	DateTime	*	Effect end date
customer	object (Customer)	*	Partner/Customer
customer_person	object (CustomerPerson)	*	Partner/Customer contact person
description	string	*
workobjects[]	array of objects (Agrifield)	*
agreement_objects[]	array of objects (AgreementObject)	*
agreement_payment_detail	object (AgreementPaymentDetail)	*
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/agreements/{id}

Modify Agreement

Documentation
Sandbox

Documentation

Modifies Agreement

Requirements

Name	Requirement	Type	Description
id		integer\|string	Agreement 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.
agreement_number	string	false
description	string	false
signing_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value stores the current time. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
from_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value stores the current time. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
to_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value stores the current time. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
agreement_type	object	false		Reference to AgreementType. Send { "id": <id> }, or null to clear.
customer	object	false		Reference to Customer. Send { "id": <id> }, or null to clear.
customer_person	object	false		Reference to CustomerPerson. 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	*
fullname	string	*	Computed field
agreement_number	string	*	Agreement number
agreement_type	object (AgreementType)	*
signing_time	DateTime	*	agreement signing Time
from_time	DateTime	*	Effect start date
to_time	DateTime	*	Effect end date
customer	object (Customer)	*	Partner/Customer
customer_person	object (CustomerPerson)	*	Partner/Customer contact person
description	string	*
workobjects[]	array of objects (Agrifield)	*
agreement_objects[]	array of objects (AgreementObject)	*
agreement_payment_detail	object (AgreementPaymentDetail)	*
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/agreements/{id}/togglearchive

Toggle Archive/Un-archive Agreement

Documentation
Sandbox

Documentation

Toggles Archive/Un-archive Agreement. Does not have a request body. The same action answers on GET and PUT.

Requirements

Name	Requirement	Type	Description
id		integer\|string	Agreement 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 (agreement, archive, classificator, 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	*
fullname	string	*	Computed field
agreement_number	string	*	Agreement number
agreement_type	object (AgreementType)	*
signing_time	DateTime	*	agreement signing Time
from_time	DateTime	*	Effect start date
to_time	DateTime	*	Effect end date
customer	object (Customer)	*	Partner/Customer
customer_person	object (CustomerPerson)	*	Partner/Customer contact person
description	string	*
workobjects[]	array of objects (Agrifield)	*
agreement_objects[]	array of objects (AgreementObject)	*
agreement_payment_detail	object (AgreementPaymentDetail)	*
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
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/agreements/{id}/togglearchive

Toggle Archive/Un-archive Agreement

Documentation
Sandbox

Documentation

Toggles Archive/Un-archive Agreement. Does not have a request body. The same action answers on GET and PUT.

Requirements

Name	Requirement	Type	Description
id		integer\|string	Agreement 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	*
fullname	string	*	Computed field
agreement_number	string	*	Agreement number
agreement_type	object (AgreementType)	*
signing_time	DateTime	*	agreement signing Time
from_time	DateTime	*	Effect start date
to_time	DateTime	*	Effect end date
customer	object (Customer)	*	Partner/Customer
customer_person	object (CustomerPerson)	*	Partner/Customer contact person
description	string	*
workobjects[]	array of objects (Agrifield)	*
agreement_objects[]	array of objects (AgreementObject)	*
agreement_payment_detail	object (AgreementPaymentDetail)	*
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
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

Classificators

Classificators are the small lookup lists the interface fills its dropdowns from - worktypes, crops, materials, statuses and similar. These endpoints return several such lists in one response, keyed by type, so a client can populate a whole screen in a single call. The search routes answer partial matches for type-ahead fields. Which lists are returned is chosen by the caller rather than fixed. Every list is scoped to the calling company.

GET /api/general/classificator_stats

Per-classificator record counts for the caller's company

Documentation
Sandbox

Documentation

Per-classificator record counts for the caller's company, restricted to the caller's departments. Returns a count per classificator type

Parameters

Parameter	Type	Required?	Format	Description
types	string	false		Comma-separated classificator names to count. Empty means every 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

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/general/classificators

classificator collections by key, each with: preferences, bookmark, id, fullname, slug

Documentation
Sandbox

Documentation

Classificator collections by key, each with: preferences, bookmark, id, fullname, slug. Returns the requested classificator collections, keyed by type

Returns arrays of objects for filling drop-down lists, together with their most crucial relations.

Possible types values are: agrifield, agrifieldonly, workobject, agrifield_group, workobject_category, material, cost_material, product_material, coating_material, workunit, material_category, amount_category, color, cost_account, cost_account_rule, country, customer, facility, maintenance_unit, main_facility, secondary_facility, facility_type, animal_type, company, company_type, crop, crop_period, crop_period_fullyear, crop_type, department, division, fuel, inspection_template, inspection_master_template, integration_partner, location_area, mobile_folder_type, pria_payee, profession, project, role, service_period, shift, time_tracking_type, worker_group, worktype, worker, project_manager, foreman, maintenance_worker. An unknown type is silently left out of the response.

Types missing here are found in GET /api/search/{classificator_type}, which is also generally preferred over this endpoint because it works faster.

Parameters

Parameter	Type	Required?	Format	Description
types	string	false		Comma delimited classificator keys, see the type list above
bookmark	integer	false		Unix timestamp bookmark; only records changed after it are returned.
editable_id	integer	false		Id of the record being edited; its own classificator values stay selectable.
forworker	boolean	false		Truthy returns only the classificators the calling worker may use.
from	date	false	YYYY-MM-DD	Start of the period, Y-m-d.
to	date	false	YYYY-MM-DD	End of the period, Y-m-d.
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (classificator, owner). 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/search/{classificator_type}

Returns array of objects for filling up drop-down lists.

Documentation
Sandbox

Documentation

Returns array of objects for filling up drop-down lists.

For every object is offered at least: id, name, updated_at_timestamp, uuid. If request is made with from_updated_at parameter, then result will contain additional parameters: is_archived, is_deleted. Some object types result contains object-specific output parameters: slug, fullname, color, field_size, hourly_rate. List is possible to filter by search query parameter "q".

Endpoint returns by default array of up to 200 elements. If slug field is present and filled, translation (according to user preferred language) must be shown instead of name. Translation slugs are constant values. If list has more than 200 elements then has_more value is set to "true". User is expected to specify search query parameter q or with parameter updated_at_timestamp.

Available classificator_type's are: agrifield, agrifieldonly, workobject, workobjectonly, agrifield_group, workobject_category, cadastre, agrifield_usage_type, field_usage_type, meadow_usage_type, material, cost_material, product_material, coating_material, spare_part, workunit, storage, material_category, material_certificate, amount_category, amount_category_seed, amount_category_plant_protection, amount_category_fertilizer, amount_category_liming, amount_category_ton, pp_material_type, fert_material_type, fert_material_code, liming_material_type, monitoring_material_type, montoring_material_category, pria_material_plant_protection, pria_material_fertilizer, pria_material_pest, pria_material_disease, pria_material_weed, pria_material_plant_event, pria_worktype, pria_payee, variety_registry, calendar_event_type, color, cost_account, cost_account_rule, currency, holiday, customer, customer_person, partner, provider, facility, maintenance_unit, main_facility, secondary_facility, facility_type, folder_layout, animal_type, company_type, crop, master_crop, crop_period, crop_period_fullyear, crop_type, crop_layer_type, crop_purpose_type, harvest_type, department, division, fuel, fuel_card, identificator_type, inspection_template, inspection_schedule, inspection_task, integration_partner, inventory_event_type, location_area, mobile_folder_type, profession, project, role, roster_type, roster_visibility, recurrence_type, plan_recurrence_type, severity, shift, time_tracking_type, worker_group, worktype, parent_worktype, faultitem_worktype, document_type, file_type, mat_inv_type, lifespan_type, agreement, agreement_type, agreement_type_pria, accounting_unit_type, worker, project_manager, foreman, maintenance_worker. Any other value returns { error: message.classificator_type_not_supported }.

Requirements

Name	Requirement	Type	Description
classificator_type		string	Classificator type name (example 'maintenance_unit')

Parameters

Parameter	Type	Required?	Format	Description
q	string	false		search query string to filter results
limit	integer	false		limit of returned records, default 200, max 1000. If there are more results, in response parameter 'has_more' will be set to true.
offset	integer	false		return records starting from offset. Offset starts from 0.
order	string	false	id\|updated_at_timestamp	by default results are sorted by name ascending, or by custom rule (for example, Workers either by firstname or lastname). This parameter allows alternatively to sort results by id ascending or by updated_at_timestamp ascending
customer_id	integer	false		limit results with customer_id (required for searching customer_person)
from_updated_at	integer	false	unix timestamp	limit results modified on or after set timestamp
facility_id	integer	false		Filter by facility id.
from	date	false	YYYY-MM-DD	Start of the period, Y-m-d.
id	integer	false		Filter by record id.
to	date	false	YYYY-MM-DD	End of the period, Y-m-d.
worker_id	integer	false		Filter by worker id.
workobject_id	integer	false		Filter by workobject id.
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (search). 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
has_more	boolean	*	True if limit parameter has filtered out some results from response, false if response is complete.
results[]	array of objects (SearchResponseResultType)	*	Array of objects, example { id: integer, name: string, updated_at_timestamp: integer, 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/search/{classificator_type}/{q}

Returns array of objects for filling up drop-down lists.

Documentation
Sandbox

Documentation

Returns array of objects for filling up drop-down lists.

For every object is offered at least: id, name, updated_at_timestamp, uuid. If request is made with from_updated_at parameter, then result will contain additional parameters: is_archived, is_deleted. Some object types result contains object-specific output parameters: slug, fullname, color, field_size, hourly_rate. List is possible to filter by search query parameter "q".

Endpoint returns by default array of up to 200 elements. If slug field is present and filled, translation (according to user preferred language) must be shown instead of name. Translation slugs are constant values. If list has more than 200 elements then has_more value is set to "true". User is expected to specify search query parameter q or with parameter updated_at_timestamp.

Available classificator_type's are: agrifield, agrifieldonly, workobject, workobjectonly, agrifield_group, workobject_category, cadastre, agrifield_usage_type, field_usage_type, meadow_usage_type, material, cost_material, product_material, coating_material, spare_part, workunit, storage, material_category, material_certificate, amount_category, amount_category_seed, amount_category_plant_protection, amount_category_fertilizer, amount_category_liming, amount_category_ton, pp_material_type, fert_material_type, fert_material_code, liming_material_type, monitoring_material_type, montoring_material_category, pria_material_plant_protection, pria_material_fertilizer, pria_material_pest, pria_material_disease, pria_material_weed, pria_material_plant_event, pria_worktype, pria_payee, variety_registry, calendar_event_type, color, cost_account, cost_account_rule, currency, holiday, customer, customer_person, partner, provider, facility, maintenance_unit, main_facility, secondary_facility, facility_type, folder_layout, animal_type, company_type, crop, master_crop, crop_period, crop_period_fullyear, crop_type, crop_layer_type, crop_purpose_type, harvest_type, department, division, fuel, fuel_card, identificator_type, inspection_template, inspection_schedule, inspection_task, integration_partner, inventory_event_type, location_area, mobile_folder_type, profession, project, role, roster_type, roster_visibility, recurrence_type, plan_recurrence_type, severity, shift, time_tracking_type, worker_group, worktype, parent_worktype, faultitem_worktype, document_type, file_type, mat_inv_type, lifespan_type, agreement, agreement_type, agreement_type_pria, accounting_unit_type, worker, project_manager, foreman, maintenance_worker. Any other value returns { error: message.classificator_type_not_supported }.

Requirements

Name	Requirement	Type	Description
classificator_type		string	Classificator type name (example 'maintenance_unit')
q

Parameters

Parameter	Type	Required?	Format	Description
q	string	false		search query string to filter results
limit	integer	false		limit of returned records, default 200, max 1000. If there are more results, in response parameter 'has_more' will be set to true.
offset	integer	false		return records starting from offset. Offset starts from 0.
order	string	false	id\|updated_at_timestamp	by default results are sorted by name ascending, or by custom rule (for example, Workers either by firstname or lastname). This parameter allows alternatively to sort results by id ascending or by updated_at_timestamp ascending
customer_id	integer	false		limit results with customer_id (required for searching customer_person)
from_updated_at	integer	false	unix timestamp	limit results modified on or after set timestamp
facility_id	integer	false		Filter by facility id.
from	date	false	YYYY-MM-DD	Start of the period, Y-m-d.
id	integer	false		Filter by record id.
to	date	false	YYYY-MM-DD	End of the period, Y-m-d.
worker_id	integer	false		Filter by worker id.
workobject_id	integer	false		Filter by workobject id.
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (search). 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
has_more	boolean	*	True if limit parameter has filtered out some results from response, false if response is complete.
results[]	array of objects (SearchResponseResultType)	*	Array of objects, example { id: integer, name: string, updated_at_timestamp: integer, 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

Show/hide List Operations Expand Operations

Companys

A Company is the tenant. Almost every other record in the API belongs to exactly one company, and the api key decides which. These endpoints read and edit the company record, restore one that was soft-deleted, and read company parameters that switch features on and off. Statistics and registration routes report activity across companies for account managers. Only superadmins and account managers can address a company other than their own.

GET /api/companies

Company collection

Documentation
Sandbox

Documentation

Returns Company collection

Parameters

Parameter	Type	Required?	Format	Description
all	boolean	false		ROLE_SUPERADMIN only. When truthy, returns every company in the installation instead of the caller's own.
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (default, companies, company_all). 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
rowclass	string	*
is_setup	boolean	*	true if Company setup is finished
id	integer	*
name	string	*	Company name
regnr	string	*
created_at_timestamp	integer	*
company_type	object (CompanyType)	*
fieldbook_plan_comments	boolean	*
fieldbook_workdone_comments	boolean	*
country_code	object (Country)	*
language_code	string	*	Default language code. In this language informational e-mails are sent.
currency_code	object (Currency)	*	Default currency in monetary fields and calculations
roster_visibility	object (RosterVisibility)	*	Default Roster Visibility type for new workers
send_welcome_letter	boolean	*	Whether new workers with e-mail set must get informational e-mail
workday_length	float	*	Workday norm hours length
overtime_length	float	*	Workday overtime hours length
permanent_delete_timestamp	integer	*
company_languages	object (CompanyLanguages)	*
test_period_days	integer	*
is_invoice_paid	boolean	*	If false, shows bink ribbon "Invoice is not paid"
is_invoice_bad	boolean	*	If true, shows big red flag "Please immediately pay, otherwise your access will be limited"
is_lastname_first	boolean	*
is_creation_enabled	boolean	*
is_regnr_verified	boolean	*
upload_max_filesize	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/companies/{id}

Delete Company by ID or UUID

Documentation
Sandbox

Documentation

Deletes Company by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	Company 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	*	Company name
company_type	object (CompanyType)	*
country_code	object (Country)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/companies/{id}

Company by ID or UUID

Documentation
Sandbox

Documentation

Returns Company by ID or UUID

Requirements

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

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (default, companies, company_all). 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
rowclass	string	*
is_setup	boolean	*	true if Company setup is finished
id	integer	*
name	string	*	Company name
regnr	string	*
created_at_timestamp	integer	*
company_type	object (CompanyType)	*
fieldbook_plan_comments	boolean	*
fieldbook_workdone_comments	boolean	*
country_code	object (Country)	*
language_code	string	*	Default language code. In this language informational e-mails are sent.
currency_code	object (Currency)	*	Default currency in monetary fields and calculations
roster_visibility	object (RosterVisibility)	*	Default Roster Visibility type for new workers
send_welcome_letter	boolean	*	Whether new workers with e-mail set must get informational e-mail
workday_length	float	*	Workday norm hours length
overtime_length	float	*	Workday overtime hours length
permanent_delete_timestamp	integer	*
company_languages	object (CompanyLanguages)	*
test_period_days	integer	*
is_invoice_paid	boolean	*	If false, shows bink ribbon "Invoice is not paid"
is_invoice_bad	boolean	*	If true, shows big red flag "Please immediately pay, otherwise your access will be limited"
is_lastname_first	boolean	*
is_creation_enabled	boolean	*
is_regnr_verified	boolean	*
upload_max_filesize	integer	*
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/companies/{id}

Modifies Company

Documentation
Sandbox

Documentation

Modifies Company. Superadmins and account managers may target any company by id; an admin may only modify their own

Requirements

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

Parameters

Parameter	Type	Required?	Description
name	string	false
regnr	string	false
fieldbook_plan_comments	boolean	false
fieldbook_workdone_comments	boolean	false
is_creation_enabled	boolean	false
is_lastname_first	boolean	false
company_type	object	false	Reference to CompanyType. Send { "id": <id> }, or null to clear.
country_code	object	false	Reference to Country. Send { "id": <id> }, or null to clear.
currency_code	object	false	Reference to Currency. Send { "id": <id> }, or null to clear.
language_code	string	false
roster_visibility	object	false	Reference to RosterVisibility. Send { "id": <id> }, or null to clear.
send_welcome_letter	boolean	false
workday_length	float	false	Decimal comma is accepted.
overtime_length	float	false	Decimal comma is accepted.
test_period_days	float	false	Decimal comma is accepted.
is_invoice_paid	boolean	false	IsInvoicePa id.
is_regnr_verified	boolean	false
upload_max_filesize	integer	false
is_invoice_bad	boolean	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
rowclass	string	*
is_setup	boolean	*	true if Company setup is finished
id	integer	*
name	string	*	Company name
regnr	string	*
created_at_timestamp	integer	*
company_type	object (CompanyType)	*
fieldbook_plan_comments	boolean	*
fieldbook_workdone_comments	boolean	*
country_code	object (Country)	*
language_code	string	*	Default language code. In this language informational e-mails are sent.
currency_code	object (Currency)	*	Default currency in monetary fields and calculations
roster_visibility	object (RosterVisibility)	*	Default Roster Visibility type for new workers
send_welcome_letter	boolean	*	Whether new workers with e-mail set must get informational e-mail
workday_length	float	*	Workday norm hours length
overtime_length	float	*	Workday overtime hours length
permanent_delete_timestamp	integer	*
company_languages	object (CompanyLanguages)	*
test_period_days	integer	*
is_invoice_paid	boolean	*	If false, shows bink ribbon "Invoice is not paid"
is_invoice_bad	boolean	*	If true, shows big red flag "Please immediately pay, otherwise your access will be limited"
is_lastname_first	boolean	*
is_creation_enabled	boolean	*
is_regnr_verified	boolean	*
upload_max_filesize	integer	*
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/company_parameter/{parameter_code}/{id}

Retrieves Company parameter data

Documentation
Sandbox

Documentation

Retrieves Company parameter data

Requirements

Name	Requirement	Type	Description
id		integer\|string	Company id or uuid
parameter_code

Parameters

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

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

Restores a soft-deleted Company

Documentation
Sandbox

Documentation

Restores a soft-deleted Company. Without an id in the URL it reports which companies can be restored

Requirements

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

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (default, companies, company_all). 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
rowclass	string	*
is_setup	boolean	*	true if Company setup is finished
id	integer	*
name	string	*	Company name
regnr	string	*
created_at_timestamp	integer	*
company_type	object (CompanyType)	*
fieldbook_plan_comments	boolean	*
fieldbook_workdone_comments	boolean	*
country_code	object (Country)	*
language_code	string	*	Default language code. In this language informational e-mails are sent.
currency_code	object (Currency)	*	Default currency in monetary fields and calculations
roster_visibility	object (RosterVisibility)	*	Default Roster Visibility type for new workers
send_welcome_letter	boolean	*	Whether new workers with e-mail set must get informational e-mail
workday_length	float	*	Workday norm hours length
overtime_length	float	*	Workday overtime hours length
permanent_delete_timestamp	integer	*
company_languages	object (CompanyLanguages)	*
test_period_days	integer	*
is_invoice_paid	boolean	*	If false, shows bink ribbon "Invoice is not paid"
is_invoice_bad	boolean	*	If true, shows big red flag "Please immediately pay, otherwise your access will be limited"
is_lastname_first	boolean	*
is_creation_enabled	boolean	*
is_regnr_verified	boolean	*
upload_max_filesize	integer	*
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/companyrestore/{id}

Restores a soft-deleted Company

Documentation
Sandbox

Documentation

Restores a soft-deleted Company. Without an id in the URL it reports which companies can be restored

Requirements

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

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (default, companies, company_all). 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
rowclass	string	*
is_setup	boolean	*	true if Company setup is finished
id	integer	*
name	string	*	Company name
regnr	string	*
created_at_timestamp	integer	*
company_type	object (CompanyType)	*
fieldbook_plan_comments	boolean	*
fieldbook_workdone_comments	boolean	*
country_code	object (Country)	*
language_code	string	*	Default language code. In this language informational e-mails are sent.
currency_code	object (Currency)	*	Default currency in monetary fields and calculations
roster_visibility	object (RosterVisibility)	*	Default Roster Visibility type for new workers
send_welcome_letter	boolean	*	Whether new workers with e-mail set must get informational e-mail
workday_length	float	*	Workday norm hours length
overtime_length	float	*	Workday overtime hours length
permanent_delete_timestamp	integer	*
company_languages	object (CompanyLanguages)	*
test_period_days	integer	*
is_invoice_paid	boolean	*	If false, shows bink ribbon "Invoice is not paid"
is_invoice_bad	boolean	*	If true, shows big red flag "Please immediately pay, otherwise your access will be limited"
is_lastname_first	boolean	*
is_creation_enabled	boolean	*
is_regnr_verified	boolean	*
upload_max_filesize	integer	*
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/companystats

Usage counts for the caller's company over a period

Documentation
Sandbox

Documentation

Usage counts for the caller's company over a period. ROLE_SUPERADMIN may pass all=1 to cover every company. Returns the company statistics for the period, or { error, error_slug } when from or to is not a date

The response has a fixed structure and may not include every field these records carry elsewhere in the API.

Parameters

Parameter	Type	Required?	Format	Description
from	date	false	YYYY-MM-DD	Start of the period, Y-m-d.
to	date	false	YYYY-MM-DD	End of the period, Y-m-d.
all	boolean	false		ROLE_SUPERADMIN only. Truthy covers every company instead of the caller's own.

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

Most recently registered companies over a period

Documentation
Sandbox

Documentation

Most recently registered companies over a period. ROLE_SUPERADMIN only; other roles receive an empty collection. Returns the latest registrations in the period, or { error, error_slug } when from or to is not a date

The response has a fixed structure and may not include every field these records carry elsewhere in the API.

Parameters

Parameter	Type	Required?	Format	Description
from	date	false	YYYY-MM-DD	Start of the period, Y-m-d.
to	date	false	YYYY-MM-DD	End of the period, Y-m-d.

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

CostAccounts

A cost account is the heading work and materials are charged to - a cost centre in everyday terms. Workdones, plan items, projects and shifts all reference one. These endpoints create, edit, list and delete cost accounts, and manage the rules that book work to them automatically. A rule matches on worktype, facility, worker or field and points at an account, so allocation follows the operation rather than the operator remembering. Rules apply when work is recorded, so changing one does not rewrite work already booked.

GET /api/costaccountrules

CostAccountRule collection

Documentation
Sandbox

Documentation

Returns CostAccountRule 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 (classificator, costaccountrule). 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
worker_ids	array	*
worker_names	string	*
id	integer	*
name	string	*
company	object (Company)	*
cost_account	object (CostAccount)	*
worktype	object (Worktype)	*
worker	object (Worker)	*
main_facility	object (Facility)	*
agrifield	object (Agrifield)	*
project	object (Project)	*
crop	object (Crop)	*
sort_order	integer	*
workers[]	array of objects (Worker)	*	Many CostAccounts have Many Workers.
is_deleted	boolean	*
is_archived	boolean	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/costaccountrules

Create new CostAccountRule

Documentation
Sandbox

Documentation

Creates new CostAccountRule

Parameters

Parameter	Type	Required?	Description
name	string	false
outer_id	string	false	Identifier in the source system.
is_deleted	boolean	false
is_active	boolean	false
worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
worktype	object	false	Reference to Worktype. Send { "id": <id> }, or null to clear.
cost_account	object	false	Reference to CostAccount. Send { "id": <id> }, or null to clear.
main_facility	object	false	Reference to Facility. Send { "id": <id> }, or null to clear.
agrifield	object	false	Reference to Agrifield. Send { "id": <id> }, or null to clear.
project	object	false	Reference to Project. Send { "id": <id> }, or null to clear.
crop	object	false	Reference to Crop. Send { "id": <id> }, or null to clear.
sort_order	integer	false
worker_ids	array of integers	false	Workers the rule applies to. 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.

Return

Parameter	Type	Versions	Description
200
worker_ids	array	*
worker_names	string	*
id	integer	*
name	string	*
company	object (Company)	*
cost_account	object (CostAccount)	*
worktype	object (Worktype)	*
worker	object (Worker)	*
main_facility	object (Facility)	*
agrifield	object (Agrifield)	*
project	object (Project)	*
crop	object (Crop)	*
sort_order	integer	*
workers[]	array of objects (Worker)	*	Many CostAccounts have Many Workers.
is_deleted	boolean	*
is_archived	boolean	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/costaccountrules/{id}

Delete CostAccountRule by ID or UUID

Documentation
Sandbox

Documentation

Deletes CostAccountRule by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	CostAccountRule 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
worker_ids	array	*
worker_names	string	*
id	integer	*
name	string	*
company	object (Company)	*
cost_account	object (CostAccount)	*
worktype	object (Worktype)	*
worker	object (Worker)	*
main_facility	object (Facility)	*
agrifield	object (Agrifield)	*
project	object (Project)	*
crop	object (Crop)	*
sort_order	integer	*
workers[]	array of objects (Worker)	*	Many CostAccounts have Many Workers.
is_deleted	boolean	*
is_archived	boolean	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/costaccountrules/{id}

CostAccountRule by ID or UUID

Documentation
Sandbox

Documentation

Returns CostAccountRule by ID or UUID

Output JSON example:

{ "id": 23398,
  "name": "Test name",
  "company": {
    "id": 3,
    "uuid": "33345cf6-ff08-11e6-bf2c-00163e034157"
  },
  "updated_at_timestamp": 1509876072,
  "is_deleted": false
}

Requirements

Name	Requirement	Type	Description
id		integer\|string	CostAccountRule 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 (classificator, costaccountrule). 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
worker_ids	array	*
worker_names	string	*
id	integer	*
name	string	*
company	object (Company)	*
cost_account	object (CostAccount)	*
worktype	object (Worktype)	*
worker	object (Worker)	*
main_facility	object (Facility)	*
agrifield	object (Agrifield)	*
project	object (Project)	*
crop	object (Crop)	*
sort_order	integer	*
workers[]	array of objects (Worker)	*	Many CostAccounts have Many Workers.
is_deleted	boolean	*
is_archived	boolean	*

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/costaccountrules/{id}

Modify CostAccountRule

Documentation
Sandbox

Documentation

Modify CostAccountRule

Requirements

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

Parameters

Parameter	Type	Required?	Description
name	string	false
outer_id	string	false	Identifier in the source system.
is_deleted	boolean	false
is_active	boolean	false
worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
worktype	object	false	Reference to Worktype. Send { "id": <id> }, or null to clear.
cost_account	object	false	Reference to CostAccount. Send { "id": <id> }, or null to clear.
main_facility	object	false	Reference to Facility. Send { "id": <id> }, or null to clear.
agrifield	object	false	Reference to Agrifield. Send { "id": <id> }, or null to clear.
project	object	false	Reference to Project. Send { "id": <id> }, or null to clear.
crop	object	false	Reference to Crop. Send { "id": <id> }, or null to clear.
sort_order	integer	false
worker_ids	array of integers	false	Workers the rule applies to. 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.

Return

Parameter	Type	Versions	Description
200
worker_ids	array	*
worker_names	string	*
id	integer	*
name	string	*
company	object (Company)	*
cost_account	object (CostAccount)	*
worktype	object (Worktype)	*
worker	object (Worker)	*
main_facility	object (Facility)	*
agrifield	object (Agrifield)	*
project	object (Project)	*
crop	object (Crop)	*
sort_order	integer	*
workers[]	array of objects (Worker)	*	Many CostAccounts have Many Workers.
is_deleted	boolean	*
is_archived	boolean	*

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

CostAccount collection

Documentation
Sandbox

Documentation

Returns CostAccount 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 (default, costaccount_all). 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
fullname	string	*
id	integer	*
name	string	*
outer_id	string	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	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/costaccounts

Create new CostAccount

Documentation
Sandbox

Documentation

Creates new CostAccount

Parameters

Parameter	Type	Required?	Description
name	string	false
outer_id	string	false	Identifier in the source system.
is_deleted	boolean	false
is_archived	boolean	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
200
fullname	string	*
id	integer	*
name	string	*
outer_id	string	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/costaccounts/{id}

Delete CostAccount by ID or UUID

Documentation
Sandbox

Documentation

Deletes CostAccount by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	CostAccount 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
200
fullname	string	*
id	integer	*
name	string	*
outer_id	string	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/costaccounts/{id}

CostAccount by ID or UUID

Documentation
Sandbox

Documentation

Returns CostAccount by ID or UUID

Output JSON example:

{ "id": 23398,
  "name": "Test name",
  "company": {
    "id": 3,
    "uuid": "33345cf6-ff08-11e6-bf2c-00163e034157"
  },
  "updated_at_timestamp": 1509876072,
  "is_deleted": false
}

Requirements

Name	Requirement	Type	Description
id		integer\|string	CostAccount 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 (default, costaccount_all). 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
fullname	string	*
id	integer	*
name	string	*
outer_id	string	*
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/costaccounts/{id}

Modify CostAccount

Documentation
Sandbox

Documentation

Modify CostAccount

Requirements

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

Parameters

Parameter	Type	Required?	Description
name	string	false
outer_id	string	false	Identifier in the source system.
is_deleted	boolean	false
is_archived	boolean	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
200
fullname	string	*
id	integer	*
name	string	*
outer_id	string	*
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

Show/hide List Operations Expand Operations

Customers

A Customer is an external party work is done for, with its own contact people. Customers can be given visibility of selected facilities, fields, worktypes and maintenance units. These endpoints create and edit customers and their contact people, and set which objects are shared with whom. Sharing is per object type, so a customer can see machinery without seeing fields. Customers can also approve completed work through a token link sent by email.

POST /api/customer/{customer_id}/person

Creates or modifies a Customer contact person

Documentation
Sandbox

Documentation

Creates / modifies Customer person

Requirements

Name	Requirement	Type	Description
customer_id		integer\|string	Customer id
id		integer\|string	Customer id or uuid

Parameters

Parameter	Type	Required?
name	string	false
email	string	false
phone	string	false
description	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
fullname	string	*
classificator	string	*
rowclass	string	*
id	integer	*
name	string	*
outer_id	string	*
registry_code	string	*	Company code or person's national id, up to 64 characters
consumer_company	object (Company)	*	In one direction, from Provider to Consumer. For reversed reports it must have second relation Will not expose consumer actual id to provider (?)
is_shared	boolean	*
sharing_start	DateTime	*	The moment when sharing starts
sharing_end	DateTime	*	The moment when sharing ends
invitation_sent_at	DateTime	*	The moment when invitation was sent
invitation_responded_at	DateTime	*	The moment when invitation was responded
email	string	*	Customer e-mail address.
customer_persons[]	array of objects (CustomerPerson)	*
agrifield	object (Agrifield)	*	Main Location (Address) of Customer
fault_severity	integer	*	Fault severity
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
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

DELETE /api/customer/{customer_id}/person/{id}

Deletes a Customer contact person

Documentation
Sandbox

Documentation

Deletes a Customer contact person. Returns { success: 1 }

Requirements

Name	Requirement	Type	Description
customer_id		integer\|string	Customer id
id		integer\|string	Customer 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
fullname	string	*
classificator	string	*
rowclass	string	*
id	integer	*
name	string	*
outer_id	string	*
registry_code	string	*	Company code or person's national id, up to 64 characters
consumer_company	object (Company)	*	In one direction, from Provider to Consumer. For reversed reports it must have second relation Will not expose consumer actual id to provider (?)
is_shared	boolean	*
sharing_start	DateTime	*	The moment when sharing starts
sharing_end	DateTime	*	The moment when sharing ends
invitation_sent_at	DateTime	*	The moment when invitation was sent
invitation_responded_at	DateTime	*	The moment when invitation was responded
email	string	*	Customer e-mail address.
customer_persons[]	array of objects (CustomerPerson)	*
agrifield	object (Agrifield)	*	Main Location (Address) of Customer
fault_severity	integer	*	Fault severity
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
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/customer/{customer_id}/person/{id}

Returns one contact person of a customer, by person id.

Documentation
Sandbox

Documentation

Returns Customer person

Requirements

Name	Requirement	Type	Description
customer_id		integer\|string	Customer id
id		integer\|string	Customer id or uuid

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (customer, 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
fullname	string	*
classificator	string	*
rowclass	string	*
id	integer	*
name	string	*
outer_id	string	*
registry_code	string	*	Company code or person's national id, up to 64 characters
consumer_company	object (Company)	*	In one direction, from Provider to Consumer. For reversed reports it must have second relation Will not expose consumer actual id to provider (?)
is_shared	boolean	*
sharing_start	DateTime	*	The moment when sharing starts
sharing_end	DateTime	*	The moment when sharing ends
invitation_sent_at	DateTime	*	The moment when invitation was sent
invitation_responded_at	DateTime	*	The moment when invitation was responded
email	string	*	Customer e-mail address.
customer_persons[]	array of objects (CustomerPerson)	*
agrifield	object (Agrifield)	*	Main Location (Address) of Customer
fault_severity	integer	*	Fault severity
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
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/customer/{customer_id}/person/{id}

Creates or modifies a Customer contact person

Documentation
Sandbox

Documentation

Creates / modifies Customer person

Requirements

Name	Requirement	Type	Description
customer_id		integer\|string	Customer id
id		integer\|string	Customer id or uuid

Parameters

Parameter	Type	Required?
name	string	false
email	string	false
phone	string	false
description	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
fullname	string	*
classificator	string	*
rowclass	string	*
id	integer	*
name	string	*
outer_id	string	*
registry_code	string	*	Company code or person's national id, up to 64 characters
consumer_company	object (Company)	*	In one direction, from Provider to Consumer. For reversed reports it must have second relation Will not expose consumer actual id to provider (?)
is_shared	boolean	*
sharing_start	DateTime	*	The moment when sharing starts
sharing_end	DateTime	*	The moment when sharing ends
invitation_sent_at	DateTime	*	The moment when invitation was sent
invitation_responded_at	DateTime	*	The moment when invitation was responded
email	string	*	Customer e-mail address.
customer_persons[]	array of objects (CustomerPerson)	*
agrifield	object (Agrifield)	*	Main Location (Address) of Customer
fault_severity	integer	*	Fault severity
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
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/customers

Customer collection

Documentation
Sandbox

Documentation

Returns Customer 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 (customer, classificator). 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
fullname	string	*
classificator	string	*
rowclass	string	*
id	integer	*
name	string	*
outer_id	string	*
registry_code	string	*	Company code or person's national id, up to 64 characters
consumer_company	object (Company)	*	In one direction, from Provider to Consumer. For reversed reports it must have second relation Will not expose consumer actual id to provider (?)
is_shared	boolean	*
sharing_start	DateTime	*	The moment when sharing starts
sharing_end	DateTime	*	The moment when sharing ends
invitation_sent_at	DateTime	*	The moment when invitation was sent
invitation_responded_at	DateTime	*	The moment when invitation was responded
email	string	*	Customer e-mail address.
customer_persons[]	array of objects (CustomerPerson)	*
agrifield	object (Agrifield)	*	Main Location (Address) of Customer
fault_severity	integer	*	Fault severity
is_deleted	boolean	*
is_archived	boolean	*
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/customers

Create new Customer

Documentation
Sandbox

Documentation

Creates new Customer

Parameters

Parameter	Type	Required?	Format	Description
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.
name	string	false		Truncated to 255 characters.
outer_id	string	false		Truncated to 32 characters.
registry_code	string	false		Truncated to 64 characters.
email	string	false		Truncated to 255 characters.
is_deleted	boolean	false
is_archived	boolean	false
is_shared	boolean	false
sharing_start	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value clears the field. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
sharing_end	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value clears the field. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
agrifield	object	false		Reference to Agrifield. Send { "id": <id> }, or null to clear.
department	object	false		Reference to Department. Send { "id": <id> }, or null to clear.
customer_persons_name	string	false		Contact person name. A contact person is created when none matches. Read only when import_type is file.
customer_persons_email	string	false		E-mail of the contact person named in customer_persons_name. Read only when import_type is file.
customer_persons_phone	string	false		Phone of the contact person named in customer_persons_name. Read only when import_type is file.
location_name	string	false		Name of the location workobject. Matched against existing workobjects and created when missing. Read only when import_type is file.
location_address	string	false		Address stored on the location workobject. Read only when import_type is file.

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
fullname	string	*
shared_facility_ids	array	*
shared_workobject_ids	array	*
shared_worktype_ids	array	*
shared_material_ids	array	*
classificator	string	*
rowclass	string	*
id	integer	*
name	string	*
outer_id	string	*
registry_code	string	*	Company code or person's national id, up to 64 characters
consumer_company	object (Company)	*	In one direction, from Provider to Consumer. For reversed reports it must have second relation Will not expose consumer actual id to provider (?)
is_shared	boolean	*
sharing_start	DateTime	*	The moment when sharing starts
sharing_end	DateTime	*	The moment when sharing ends
invitation_sent_at	DateTime	*	The moment when invitation was sent
invitation_responded_at	DateTime	*	The moment when invitation was responded
email	string	*	Customer e-mail address.
customer_persons[]	array of objects (CustomerPerson)	*
agrifield	object (Agrifield)	*	Main Location (Address) of Customer
fault_severity	integer	*	Fault severity
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
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

PUT /api/customers/share_object/{object_type}/{object_id}

Shares one object of the given type with customers

Documentation
Sandbox

Documentation

Shares one object of the type named in the URL with customers. Returns { message: message.success }, or message.record_not_found when the object is unknown

Requirements

Name	Requirement	Type	Description
object_type		string	One of: main_facility, facility, workobject, agrifield, worktype, maintenance_unit, material. facility equals main_facility, agrifield equals workobject
object_id		integer\|string	Id of the Terake object, of the type named by object_type

Parameters

Parameter	Type	Required?	Format	Description
partner_ids	array of integers	true		Customers the object is shared with. Replaces the whole set

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

PUT /api/customers/{customer_id}/share/{object_type}

Sets which objects of one type are shared with a Customer

Documentation
Sandbox

Documentation

Set shared Objects (main_facility, facility, workobject, agrifield, worktype, maintenance_unit, material)

Requirements

Name	Requirement	Type	Description
customer_id		integer\|string	Customer id
object_type		string	One of: main_facility, facility, workobject, agrifield, worktype, maintenance_unit, material. facility equals main_facility, agrifield equals workobject

Parameters

Parameter	Type	Required?	Format	Description
ids	array of integers	true		Objects of the given type shared with the Customer. Replaces the whole set

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
fullname	string	*
shared_facility_ids	array	*
shared_workobject_ids	array	*
shared_worktype_ids	array	*
shared_material_ids	array	*
classificator	string	*
rowclass	string	*
id	integer	*
name	string	*
outer_id	string	*
registry_code	string	*	Company code or person's national id, up to 64 characters
consumer_company	object (Company)	*	In one direction, from Provider to Consumer. For reversed reports it must have second relation Will not expose consumer actual id to provider (?)
is_shared	boolean	*
sharing_start	DateTime	*	The moment when sharing starts
sharing_end	DateTime	*	The moment when sharing ends
invitation_sent_at	DateTime	*	The moment when invitation was sent
invitation_responded_at	DateTime	*	The moment when invitation was responded
email	string	*	Customer e-mail address.
customer_persons[]	array of objects (CustomerPerson)	*
agrifield	object (Agrifield)	*	Main Location (Address) of Customer
fault_severity	integer	*	Fault severity
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

DELETE /api/customers/{id}

Delete Customer by ID or UUID

Documentation
Sandbox

Documentation

Deletes Customer by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	Customer 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
fullname	string	*
classificator	string	*
rowclass	string	*
id	integer	*
name	string	*
outer_id	string	*
registry_code	string	*	Company code or person's national id, up to 64 characters
consumer_company	object (Company)	*	In one direction, from Provider to Consumer. For reversed reports it must have second relation Will not expose consumer actual id to provider (?)
is_shared	boolean	*
sharing_start	DateTime	*	The moment when sharing starts
sharing_end	DateTime	*	The moment when sharing ends
invitation_sent_at	DateTime	*	The moment when invitation was sent
invitation_responded_at	DateTime	*	The moment when invitation was responded
email	string	*	Customer e-mail address.
customer_persons[]	array of objects (CustomerPerson)	*
agrifield	object (Agrifield)	*	Main Location (Address) of Customer
fault_severity	integer	*	Fault severity
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
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/customers/{id}

Customer by ID or UUID

Documentation
Sandbox

Documentation

Returns Customer by ID or UUID

Output JSON example:

{ "id": 23398,
  "name": "Test name",
  "company": {
    "id": 3,
    "uuid": "33345cf6-ff08-11e6-bf2c-00163e034157"
  },
  "updated_at_timestamp": 1509876072,
  "is_deleted": false
}

Requirements

Name	Requirement	Type	Description
id		integer\|string	Customer 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 (customer, customer_all, sharing, classificator, 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
fullname	string	*
shared_facility_ids	array	*
shared_workobject_ids	array	*
shared_worktype_ids	array	*
shared_material_ids	array	*
classificator	string	*
rowclass	string	*
id	integer	*
name	string	*
outer_id	string	*
registry_code	string	*	Company code or person's national id, up to 64 characters
consumer_company	object (Company)	*	In one direction, from Provider to Consumer. For reversed reports it must have second relation Will not expose consumer actual id to provider (?)
is_shared	boolean	*
sharing_start	DateTime	*	The moment when sharing starts
sharing_end	DateTime	*	The moment when sharing ends
invitation_sent_at	DateTime	*	The moment when invitation was sent
invitation_responded_at	DateTime	*	The moment when invitation was responded
email	string	*	Customer e-mail address.
customer_persons[]	array of objects (CustomerPerson)	*
agrifield	object (Agrifield)	*	Main Location (Address) of Customer
fault_severity	integer	*	Fault severity
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	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

PUT /api/customers/{id}

Modify Customer

Documentation
Sandbox

Documentation

Modify Customer

Requirements

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

Parameters

Parameter	Type	Required?	Format	Description
name	string	false		Truncated to 255 characters.
outer_id	string	false		Truncated to 32 characters.
registry_code	string	false		Truncated to 64 characters.
email	string	false		Truncated to 255 characters.
is_deleted	boolean	false
is_archived	boolean	false
is_shared	boolean	false
sharing_start	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value clears the field. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
sharing_end	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value clears the field. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
agrifield	object	false		Reference to Agrifield. Send { "id": <id> }, or null to clear.
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
fullname	string	*
shared_facility_ids	array	*
shared_workobject_ids	array	*
shared_worktype_ids	array	*
shared_material_ids	array	*
classificator	string	*
rowclass	string	*
id	integer	*
name	string	*
outer_id	string	*
registry_code	string	*	Company code or person's national id, up to 64 characters
consumer_company	object (Company)	*	In one direction, from Provider to Consumer. For reversed reports it must have second relation Will not expose consumer actual id to provider (?)
is_shared	boolean	*
sharing_start	DateTime	*	The moment when sharing starts
sharing_end	DateTime	*	The moment when sharing ends
invitation_sent_at	DateTime	*	The moment when invitation was sent
invitation_responded_at	DateTime	*	The moment when invitation was responded
email	string	*	Customer e-mail address.
customer_persons[]	array of objects (CustomerPerson)	*
agrifield	object (Agrifield)	*	Main Location (Address) of Customer
fault_severity	integer	*	Fault severity
created_at_timestamp	integer	*
created_by	object (Worker)	*
updated_by	object (Worker)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	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

Show/hide List Operations Expand Operations

LocationAreas

A location area groups fields geographically - a region, a farm or a block. Fields, agrifield works and reports can be filtered by area. These endpoints create, edit, list and delete areas. An area is a label for reporting rather than a geometry in its own right. One field belongs to one area.

GET /api/locationareas

LocationArea collection

Documentation
Sandbox

Documentation

Returns LocationArea 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 (location_area). 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	*
company	object (Company)	*
outer_id	string	*	ID in external system like code in accounting system, etc

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/locationareas

Create new LocationArea

Documentation
Sandbox

Documentation

Creates new LocationArea

Parameters

Parameter	Type	Required?	Description
name	string	false
outer_id	string	false	Identifier in the source system.
is_deleted	boolean	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	*
company	object (Company)	*
outer_id	string	*	ID in external system like code in accounting system, etc

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/locationareas/{id}

Delete LocationArea by ID or UUID

Documentation
Sandbox

Documentation

Deletes LocationArea by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	LocationArea 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	*
company	object (Company)	*
outer_id	string	*	ID in external system like code in accounting system, etc

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/locationareas/{id}

LocationArea by ID or UUID

Documentation
Sandbox

Documentation

Returns LocationArea by ID or UUID

Output JSON example:

{ "id": 23398,
  "name": "Test name",
  "company": {
    "id": 3,
    "uuid": "33345cf6-ff08-11e6-bf2c-00163e034157"
  },
  "updated_at_timestamp": 1509876072,
  "is_deleted": false
}

Requirements

Name	Requirement	Type	Description
id		integer\|string	LocationArea 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 (location_area). 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	*
company	object (Company)	*
outer_id	string	*	ID in external system like code in accounting system, etc

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/locationareas/{id}

Modify LocationArea

Documentation
Sandbox

Documentation

Modify LocationArea

Requirements

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

Parameters

Parameter	Type	Required?	Description
name	string	false
outer_id	string	false	Identifier in the source system.
is_deleted	boolean	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	*
company	object (Company)	*
outer_id	string	*	ID in external system like code in accounting system, etc

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

Messages

Messages and notifications are what the system sends to workers - a plan assigned, a fault reported, a document to sign. A notification is addressed to one worker and tracks whether it has been opened. These endpoints send a message, list new notifications and mark one read. Silent notifications exist so a client can be updated without the worker seeing anything. Message text itself is stored in the database rather than in translation files.

GET /api/message

Message collection

Documentation
Sandbox

Documentation

Returns Message collection (Array of json entries)

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 this Unix timestamp, including deleted and archived ones
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (default, message). 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	*
from_worker	object (Worker)	*
message_type	object (MessageType)	*
body_text	string	*
body_text_html	string	*
created_at	DateTime	*
responded_at	DateTime	*
updated_at	DateTime	*
deleted_at	DateTime	*
status_code	string	*
urgency	integer	*	Currently three levels: 0 - none, 100 - informative, 200 - urgent
objects[]	array of objects (MessageObject)	*
subject	string	*
send_email	boolean	*
valid_until	DateTime	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/message

Creates a new Message

Documentation
Sandbox

Documentation

Creates a new Message. Returns the string OK

Parameters

Parameter	Type	Required?	Format	Description
message_type	integer	true		MessageType the message is created from. Its area decides what related_ids point at
related_ids	array of integers	false		Objects the message is attached to, of the type implied by message_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

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/message/{id}

Deletes a Message by id or uuid

Documentation
Sandbox

Documentation

Deletes Message by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	Message 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	*
from_worker	object (Worker)	*
message_type	object (MessageType)	*
body_text	string	*
body_text_html	string	*
created_at	DateTime	*
responded_at	DateTime	*
updated_at	DateTime	*
deleted_at	DateTime	*
status_code	string	*
urgency	integer	*	Currently three levels: 0 - none, 100 - informative, 200 - urgent
objects[]	array of objects (MessageObject)	*
subject	string	*
send_email	boolean	*
valid_until	DateTime	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/message/{id}

Message by id or uuid

Documentation
Sandbox

Documentation

Returns Message by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	Message 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 (message). 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	*
from_worker	object (Worker)	*
message_type	object (MessageType)	*
body_text	string	*
body_text_html	string	*
created_at	DateTime	*
responded_at	DateTime	*
updated_at	DateTime	*
deleted_at	DateTime	*
status_code	string	*
urgency	integer	*	Currently three levels: 0 - none, 100 - informative, 200 - urgent
objects[]	array of objects (MessageObject)	*
subject	string	*
send_email	boolean	*
valid_until	DateTime	*

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/notification-read/{id}

Marks a notification as read

Documentation
Sandbox

Documentation

Set notification read

Requirements

Name	Requirement	Type	Description
id		integer\|string	Message 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	*
to_worker	object (Worker)	*	Worker to be notified about message Must be serialized with MaxDepth(2) because Terake Workfields (Android native app) goes mad when Worker object doesnt have assigned inflated Company property
message	object (Message)	*	Message to be sent
opened_at	DateTime	*
updated_at	DateTime	*
deleted_at	DateTime	*
status_code	string	*
is_silent	boolean	*
emailed_at	DateTime	*
uuid	string	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/notifications

Notifications for the calling worker, paged

Documentation
Sandbox

Documentation

Notifications for the calling worker, paged. Returns { pagination, collection } for the requested page of notifications

Parameters

Parameter	Type	Required?	Description
current_page	integer	false	Page to return. Defaults to 1
per_page	integer	false	Notifications per page. Defaults to 500
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (message). 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/notifications/new

Unread notifications for the calling worker, newest first, capped at 99

Documentation
Sandbox

Documentation

Unread notifications for the calling worker, newest first, capped at 99. Silent and deleted notifications are left out

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (message). 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	*
to_worker	object (Worker)	*	Worker to be notified about message Must be serialized with MaxDepth(2) because Terake Workfields (Android native app) goes mad when Worker object doesnt have assigned inflated Company property
message	object (Message)	*	Message to be sent
opened_at	DateTime	*
updated_at	DateTime	*
deleted_at	DateTime	*
status_code	string	*
is_silent	boolean	*
emailed_at	DateTime	*
uuid	string	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/notifications/{current_page}

Notifications for the calling worker, paged

Documentation
Sandbox

Documentation

Notifications for the calling worker, paged. Returns { pagination, collection } for the requested page of notifications

Requirements

Name	Requirement	Type	Description
current_page

Parameters

Parameter	Type	Required?	Description
current_page	integer	false	Page to return. Defaults to 1
per_page	integer	false	Notifications per page. Defaults to 500
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (message). 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/notifications_unread

Unread notifications for the calling worker, newest first, capped at 99

Documentation
Sandbox

Documentation

Unread notifications for the calling worker, newest first, capped at 99. Silent and deleted notifications are left out

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (message). 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	*
to_worker	object (Worker)	*	Worker to be notified about message Must be serialized with MaxDepth(2) because Terake Workfields (Android native app) goes mad when Worker object doesnt have assigned inflated Company property
message	object (Message)	*	Message to be sent
opened_at	DateTime	*
updated_at	DateTime	*
deleted_at	DateTime	*
status_code	string	*
is_silent	boolean	*
emailed_at	DateTime	*
uuid	string	*

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

MobileFolderSlots

A mobile folder slot decides what appears on the home screen of the mobile application and in which order. Each slot points at a folder type and a position. These endpoints create, edit, list and delete slots. Configuring slots is how a company tailors the app to the work its people actually do. Slots are per company rather than per worker.

GET /api/mobilefolderslots

MobileFolderSlot collection

Documentation
Sandbox

Documentation

Returns MobileFolderSlot 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 (default, mobilefolderslots). 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
id	integer	*
name	string	*
company	object (Company)	*
mobile_folder_type	object (MobileFolderType)	*
slot_number	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	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/mobilefolderslots

Create new MobileFolderSlot

Documentation
Sandbox

Documentation

Creates new MobileFolderSlot

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
slot_number	integer	false
mobile_folder_type	object	false	Reference to MobileFolderType. 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
200
id	integer	*
name	string	*
company	object (Company)	*
mobile_folder_type	object (MobileFolderType)	*
slot_number	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/mobilefolderslots/{id}

Delete MobileFolderSlot by ID or UUID

Documentation
Sandbox

Documentation

Deletes MobileFolderSlot by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	MobileFolderSlot 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
200
id	integer	*
name	string	*
company	object (Company)	*
mobile_folder_type	object (MobileFolderType)	*
slot_number	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/mobilefolderslots/{id}

MobileFolderSlot by ID or UUID

Documentation
Sandbox

Documentation

Returns MobileFolderSlot by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	MobileFolderSlot 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 (default, mobilefolderslots). 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
id	integer	*
name	string	*
company	object (Company)	*
mobile_folder_type	object (MobileFolderType)	*
slot_number	integer	*
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/mobilefolderslots/{id}

Modifies MobileFolderSlot

Documentation
Sandbox

Documentation

Modifies MobileFolderSlot

Requirements

Name	Requirement	Type	Description
id		integer\|string	MobileFolderSlot 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
slot_number	integer	false
mobile_folder_type	object	false	Reference to MobileFolderType. 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
200
id	integer	*
name	string	*
company	object (Company)	*
mobile_folder_type	object (MobileFolderType)	*
slot_number	integer	*
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

Show/hide List Operations Expand Operations

Settings

These endpoints hold per-company configuration rather than business data: application settings, which columns a table shows, and the relations between arbitrary Terake objects. Settings are stored as JSON under a key, so the shape is whatever the interface saved. Bulk actions that change many records of one type at once also live here. The relation routes let objects of different types be linked without a dedicated table for each pair. Nothing here is scoped narrower than the company.

GET /api/appsettings/visiblefields/{tablename}

visible fields name array

Documentation
Sandbox

Documentation

Visible fields name array. Returns the stored column list decoded from JSON; the shape is whatever the admin UI saved for the table

Requirements

Name	Requirement	Type	Description
tablename

Parameters

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

PUT /api/appsettings/visiblefields/{tablename}

Saves which columns are visible for a table in the admin UI

Documentation
Sandbox

Documentation

Saves which columns are visible for a table in the admin UI. Returns the stored column list decoded from JSON; the shape is whatever the admin UI saved for the table

Requirements

Name	Requirement	Type	Description
tablename

Parameters

Parameter	Type	Required?	Format	Description
tablename	string	true		Admin UI table name the column list is stored under

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/appsettings/{key}

visible fields name array

Documentation
Sandbox

Documentation

Visible fields name array. Returns the stored setting decoded from JSON; the shape is whatever was saved under the key

Requirements

Name	Requirement	Type	Description
key

Parameters

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

PUT /api/appsettings/{key}

Saves one application setting by key

Documentation
Sandbox

Documentation

Saves one application setting by key. Returns the stored setting decoded from JSON; the shape is whatever was saved under the key

Requirements

Name	Requirement	Type	Description
key

Parameters

Parameter	Type	Required?	Format	Description
key	string	true		Setting key the content is stored under

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

PUT /api/entity/multiaction/{id}

Applies a bulk action to the listed records of one entity type

Documentation
Sandbox

Documentation

Toggles entity archive status

Requirements

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

Parameters

Parameter	Type	Required?	Description
entityname	string	true	Entity the bulk action applies to.
ids	array of integers	true	Records the action is applied to.
action	string	true	Action to perform on each record.

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
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/general/multiset

Applies a bulk change to the listed records of one entity type

Documentation
Sandbox

Documentation

Applies a bulk change to the listed records of one entity type. Returns the records that were changed

Parameters

Parameter	Type	Required?	Description
entity_name	string	true	Entity the bulk operation applies to.
ids	array of integers	true	Records to change.
data	object	false	Values to write, keyed by field name.
allowed	object	false	Per-field flags marking which entries of data may be written.
entities	array of objects	false	Records to change, sent inline instead of by 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/modificationlog/{entity_type}/{id}

List Entity modifications

Documentation
Sandbox

Documentation

List Entity modifications

Requirements

Name	Requirement	Type	Description
id		integer\|string	ModificationLog id or uuid
entity_type

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (realtime). 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
action_code	string	*
created_at	DateTime	*
created_by	object (Worker)	*

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

Network and Backend availability check, returns 'pong' with server timestamp

Documentation
Sandbox

Documentation

returns Pong

Parameters

Parameter	Type	Required?	Description
device_uuid	string	false	Has no effect, just stored to server access log
worker_uuid	string	false	Has no effect, just stored to server access log
lat	string	false	Has no effect, just stored to server access log
lng	string	false	Has no effect, just stored to server access log

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET DEPRECATED /api/relations-test/{object_type}/{object_id}

Test route for reading Terake object relations

Documentation
Sandbox

Documentation

Test route for reading Terake object relations. Superseded by /api/relations/{object_type}/{object_id}

Requirements

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

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (classificator). 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	*
first_object_code	object (TerakeObjectType)	*	atORM\Column(type="string", length=255)
first_id	integer	*	First Object Id in Terake system
second_object_code	object (TerakeObjectType)	*	atORM\Column(type="string", length=255)
second_id	integer	*	Related object Id in Terake system
relation_type	integer	*
last_used_at	DateTime	*
count_workdone	integer	*	Usage count in Workdones
count_roster	integer	*	Usage count in Rosteritems
is_deleted	boolean	*
is_archived	boolean	*

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/relations/{object_type}/{object_id}

Returns the objects related to one Terake object

Documentation
Sandbox

Documentation

Returns the objects related to one Terake object. Pass classificator as a comma-separated list to choose which relation types are returned; it defaults to worktype

Requirements

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

Parameters

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

PUT /api/terake-relations

Replaces the relations between one Terake object and a set of objects of another type

Documentation
Sandbox

Documentation

Replaces the relations between one Terake object and a set of objects of another type. Returns the relations that were written

Parameters

Parameter	Type	Required?	Description
first_object_code	string	true	Type code of the object the relations belong to
first_id	integer	true	Id of that object
second_object_code	string	true	Type code of the related objects
second_ids	array of integers	true	Related objects. Replaces the whole set

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

WorkdayRules

A workday rule decides how recorded hours are counted: what makes a normal day, when overtime starts, how breaks and night hours are treated. Rules are applied when work hours are summarised rather than when work is recorded. These endpoints create, edit, list and delete rules. Changing a rule changes future summaries, not the underlying Workdones. The summaries themselves are read under Reports.

GET /api/workdayrules

WorkdayRules collection

Documentation
Sandbox

Documentation

Returns WorkdayRules 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 (workdayrules). 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
pause_minutes	string	*
duration_minutes	string	*
min_duration_minutes	string	*
id	integer	*
department	object (Department)	*	Department
worker_group	object (WorkerGroup)	*	Department
duration_seconds	integer	*	Duration of daily work
min_duration_seconds	integer	*	Minimum duration of work
pause_seconds	integer	*	Duration of pause
is_gaps_filled	boolean	*
start_date	DateTime	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/workdayrules

Create new WorkdayRule

Documentation
Sandbox

Documentation

Creates new WorkdayRule

Parameters

Parameter	Type	Required?	Format	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".
department	object	false		Reference to Department. Send { "id": <id> }, or null to clear.
worker_group	object	false		Reference to WorkerGroup. Send { "id": <id> }, or null to clear.
duration_minutes	string	false	HH:MM or HH:MM:SS	Duration as HH:MM or HH:MM:SS, or a plain number of seconds. It is stored as seconds.
min_duration_minutes	string	false	HH:MM or HH:MM:SS	Duration as HH:MM or HH:MM:SS, or a plain number of seconds. It is stored as seconds.
pause_minutes	string	false	HH:MM or HH:MM:SS	Duration as HH:MM or HH:MM:SS, or a plain number of seconds. It is stored as seconds.
is_gaps_filled	boolean	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
pause_minutes	string	*
duration_minutes	string	*
min_duration_minutes	string	*
id	integer	*
department	object (Department)	*	Department
worker_group	object (WorkerGroup)	*	Department
duration_seconds	integer	*	Duration of daily work
min_duration_seconds	integer	*	Minimum duration of work
pause_seconds	integer	*	Duration of pause
is_gaps_filled	boolean	*
start_date	DateTime	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/workdayrules/{id}

Delete WorkdayRule by ID or UUID

Documentation
Sandbox

Documentation

Deletes WorkdayRule by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	WorkdayRule 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
pause_minutes	string	*
duration_minutes	string	*
min_duration_minutes	string	*
id	integer	*
department	object (Department)	*	Department
worker_group	object (WorkerGroup)	*	Department
duration_seconds	integer	*	Duration of daily work
min_duration_seconds	integer	*	Minimum duration of work
pause_seconds	integer	*	Duration of pause
is_gaps_filled	boolean	*
start_date	DateTime	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/workdayrules/{id}

WorkdayRule by ID or UUID

Documentation
Sandbox

Documentation

Returns WorkdayRule by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	WorkdayRule 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 (workdayrules). 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
pause_minutes	string	*
duration_minutes	string	*
min_duration_minutes	string	*
id	integer	*
department	object (Department)	*	Department
worker_group	object (WorkerGroup)	*	Department
duration_seconds	integer	*	Duration of daily work
min_duration_seconds	integer	*	Minimum duration of work
pause_seconds	integer	*	Duration of pause
is_gaps_filled	boolean	*
start_date	DateTime	*

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/workdayrules/{id}

Modify WorkdayRule

Documentation
Sandbox

Documentation

Updates WorkdayRule

Requirements

Name	Requirement	Type	Description
id		integer\|string	WorkdayRule 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.
department	object	false		Reference to Department. Send { "id": <id> }, or null to clear.
worker_group	object	false		Reference to WorkerGroup. Send { "id": <id> }, or null to clear.
duration_minutes	string	false	HH:MM or HH:MM:SS	Duration as HH:MM or HH:MM:SS, or a plain number of seconds. It is stored as seconds.
min_duration_minutes	string	false	HH:MM or HH:MM:SS	Duration as HH:MM or HH:MM:SS, or a plain number of seconds. It is stored as seconds.
pause_minutes	string	false	HH:MM or HH:MM:SS	Duration as HH:MM or HH:MM:SS, or a plain number of seconds. It is stored as seconds.
is_gaps_filled	boolean	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
pause_minutes	string	*
duration_minutes	string	*
min_duration_minutes	string	*
id	integer	*
department	object (Department)	*	Department
worker_group	object (WorkerGroup)	*	Department
duration_seconds	integer	*	Duration of daily work
min_duration_seconds	integer	*	Minimum duration of work
pause_seconds	integer	*	Duration of pause
is_gaps_filled	boolean	*
start_date	DateTime	*

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

Workers

A Worker is a person with access to the system, belonging to exactly one company. The worker record carries their roles, department, profession, credentials and the rates their work is charged at. These endpoints create and edit workers, set roles, passwords, PIN and card credentials, and define which workers a foreman may approve for. Brigade routes let a foreman start and stop work for a whole crew at once. A worker is archived rather than removed so their recorded work stays attributable.

GET /api/my/apikey

Returns the calling Worker's own API key

Documentation
Sandbox

Documentation

Handles showing the calling Worker their own API key

The only endpoint that returns the key to a caller signed in with an access token; other responses to such callers leave it out. Every call is recorded in the Worker's change history, and the response is marked not to be cached.

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

POST /api/my/apikey/renew

Replaces the calling Worker's API key at once and returns the new one

Documentation
Sandbox

Documentation

Handles replacing the calling Worker's API key straight away

The previous key stops working the moment this returns, so every client that was signed in with it - the mobile app, browser sessions on other devices, integrations - has to sign in again. The response carries the new key so the caller can carry on.

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

POST /api/my/apikey/renew-at-next-login

Marks the calling Worker's API key to be replaced at the next sign-in

Documentation
Sandbox

Documentation

Handles marking the calling Worker's API key to be replaced at the next sign-in

The key keeps working until the Worker signs in again, and is replaced at that point. Meant for keys that leave Terake - pasted into a chat window, a script or a third party tool - so that what was handed out only stays valid until the next sign-in.

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

POST /api/my/roster-visibility

Shows or hides the calendar for the calling Worker

Documentation
Sandbox

Documentation

Handles shows or hides the calendar for the calling 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
roster_visibility	object (RosterVisibility)	*	Roster Visibility type

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/relate/{provider}/{token}

Links an existing Worker to a Google or Facebook identity

Documentation
Sandbox

Documentation

Handles links an existing Worker to a Google or Facebook identity

Requirements

Name	Requirement	Type	Description
provider
token

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
companies	array	*	For maintaining companies selection
has_password	boolean	*	For obtaining default worker
id	integer	*
google_id	string	*
facebook_id	string	*
personal_code	string	*
personal_code_country	string	*
email	string	*
fullname	string	*
firstname	string	*
lastname	string	*
email_verified	integer	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/send_welcome_letter/{id}

Sends the welcome letter to a Worker

Documentation
Sandbox

Documentation

Sends the welcome letter to a Worker. Returns { result: OK }

Requirements

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

Parameters

Parameter	Type	Required?	Format	Description
email	string	false		Address the welcome letter is sent to. Defaults to the worker e-mail

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

Creates a new WorkerSummarisedWorktime, or modifies the one named in the URL

Documentation
Sandbox

Documentation

Creates WorkerSummarisedWorktime.

Requirements

Name	Requirement	Type	Description
worker_id		integer	Worker id

Parameters

Parameter	Type	Required?	Format	Description
start_time	datetime	false	YYYY-MM-DD HH:MM:SS	Start time. Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00.
summarised_months	integer	false		Summarised months

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
id	integer	*
start_time	DateTime	*
stop_time	DateTime	*
summarised_months	integer	*
norm_hours	integer	*
norm_days	integer	*

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/summarised_worktime/{id}

Creates a new WorkerSummarisedWorktime, or modifies the one named in the URL

Documentation
Sandbox

Documentation

Creates a new WorkerSummarisedWorktime, or modifies the one named in the URL. Same action as the POST route

Requirements

Name	Requirement	Type	Description
id		integer	WorkerSummarisedWorktime id

Parameters

Parameter	Type	Required?	Format	Description
start_time	datetime	false	YYYY-MM-DD HH:MM:SS	Start time. Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00.
summarised_months	integer	false		Summarised months

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
id	integer	*
start_time	DateTime	*
stop_time	DateTime	*
summarised_months	integer	*
norm_hours	integer	*
norm_days	integer	*

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/summarised_worktime/{worker_id}

Summarised worktime list by worker.

Documentation
Sandbox

Documentation

Returns WorkerSummarisedWorktime list by worker.

Requirements

Name	Requirement	Type	Description
worker_id		integer	Worker id

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (summarised_worktime). 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
id	integer	*
start_time	DateTime	*
stop_time	DateTime	*
summarised_months	integer	*
norm_hours	integer	*
norm_days	integer	*

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/summarised_worktime/{worker_id}/{id}

Delete WorkerSummarisedWorktime

Documentation
Sandbox

Documentation

Deletes WorkerSummarisedWorktime. Returns { id, is_deleted: true }

Requirements

Name	Requirement	Type	Description
worker_id		integer\|string	Worker id
id		integer	WorkerSummarisedWorktime 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

POST /api/unrelate/{provider}

Unlinks a Worker from a Google or Facebook identity

Documentation
Sandbox

Documentation

Unlinks a Worker from a Google or Facebook identity. Returns { success: true }

Requirements

Name	Requirement	Type	Description
provider

Parameters

Parameter	Type	Required?	Format	Description
token	string	false		Token from the identity provider being unlinked

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

Creates a user account linked to a Google or Facebook identity

Documentation
Sandbox

Documentation

Creates a user account linked to a Google or Facebook identity

Parameters

Parameter	Type	Required?	Description
firstname	string	true	First name of the account holder
lastname	string	true	Last name of the account holder
email	string	true	E-mail, also 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.

Return

Parameter	Type	Versions	Description
200
companies	array	*	For maintaining companies selection
has_password	boolean	*	For obtaining default worker
id	integer	*
google_id	string	*
facebook_id	string	*
personal_code	string	*
personal_code_country	string	*
email	string	*
fullname	string	*
firstname	string	*
lastname	string	*
email_verified	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/usersearch/{q}

Searches user accounts by name

Documentation
Sandbox

Documentation

Searches user accounts by name

Requirements

Name	Requirement	Type	Description
q

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (user, worker, baseattribute, classificator, owner). 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
id	integer	*
google_id	string	*
facebook_id	string	*
personal_code	string	*
personal_code_country	string	*
email	string	*
fullname	string	*
firstname	string	*
lastname	string	*
username	string	*
email_verified	integer	*
updated_at	DateTime	*
inserted_at	DateTime	*
workers[]	array of objects (Worker)	*
default_worker	object (Worker)	*
created_at_timestamp	integer	*
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-generatepin/{id}

Generates factory credentials (PIN) for a Worker

Documentation
Sandbox

Documentation

Handles generates factory credentials (PIN) for a Worker

Requirements

Name	Requirement	Type	Description
id		integer\|string	Worker 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
200
id	integer	*
factory_pin	string	*
factory_rfid	string	*
factory_nfc	string	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/workers

All Workers list

Documentation
Sandbox

Documentation

Workers list

Parameters

Parameter	Type	Required?	Format	Description
is_archived	boolean	false	true or 1	If is_archived=1 then return also archived records
archived	boolean	false		Alias of is_archived; either being truthy has the same effect.
from_updated_at	string	false	Unix timestamp	Return only records updated on or after Unix timestamp
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (workerlist, baseattribute, department). 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
roles_array	array	*	Worker app / My Profile uses this
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
profession	object (Profession)	*	Profession
boss	object (Worker)	*
facility	object (Facility)	*	Workers main facility
outer_id	string	*	Worker Id in external system, for example code in Accounting or Human Resources system.
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
factory_credentials	object (WorkerFactoryCredentials)	*	@ORM\OneToOne(targetEntity="WorkerFactoryCredentials", mappedBy="worker" )
hourly_rate	float	*	Hourly rate, 2 decimal Number (0.00)
personal_code	string	*	Personal code or national personal id, up to 64 characters
is_personal_code_verified	boolean	*
qr	string	*	QR code This is copy of QrImage->QrText parameter for fast querying in lists
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/workers

Create Worker

Documentation
Sandbox

Documentation

Creates new Worker

Parameters

Parameter	Type	Required?	Format	Description
id	integer	false		Updates this record instead of creating one, when given.
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.
firstname	string	true
lastname	string	true
email	string	false		Truncated to 200 characters.
phone	string	false		Truncated to 25 characters.
outer_id	string	false		Truncated to 40 characters.
description	string	false		Truncated to 255 characters.
profession	object	false		Reference to Profession. Send { "id": <id> }, or null to clear.
facility	object	false		Reference to Facility. Send { "id": <id> }, or null to clear.
worktype	object	false		Reference to Worktype. Send { "id": <id> }, or null to clear.
boss	object	false		Reference to Worker. Send { "id": <id> }, or null to clear.
company_type	object	false		Reference to CompanyType. Send { "id": <id> }, or null to clear.
time_tracking_type	object	false		Reference to TimeTrackingType. Send { "id": <id> }, or null to clear.
gps_tracking_interval	integer	false
is_archived	boolean	false
is_foreman_manageable	boolean	false		Stored as 1 or 0.
department	object	false		Reference to Department. Send { "id": <id> }, or null to clear.
gps_required	boolean	false
hourly_rate	float	false		Decimal comma is accepted.
roster_visibility	object	false		Reference to RosterVisibility. Send { "id": <id> }, or null to clear.
start_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value clears the field. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
stop_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value clears the field. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
is_personal_code_verified	boolean	false
personal_code	string	false
send_welcome_letter	boolean	false		Sends the welcome letter to email. Defaults to the company setting when omitted.
language_code	string	false		Language of the welcome letter. Defaults to the company language.
modification_start_time	datetime	false	YYYY-MM-DD HH:MM:SS	Start of the period the change applies from. Defaults to 1970-01-01. Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00.
password1	string	true		Password
password2	string	true		Password repeat

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_boolean	boolean	*
crop_periods_visible_ids	array	*
pria_payee_ids	array	*
agrifield_ids	array	*
approvable_ids	array	*
approver_ids	array	*
brigade_member_ids	array	*
subordinate_ids	array	*
role_ids	array	*
roles_array	array	*	Worker app / My Profile uses this
classificator	string	*
color	string	*
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
profession	object (Profession)	*	Profession
boss	object (Worker)	*
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
subordinates[]	array of objects (Worker)	*
outer_id	string	*	Worker Id in external system, for example code in Accounting or Human Resources system.
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
company_type	object (CompanyType)	*	If workers type is different from Companies generic type
description	string	*
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
is_foreman_manageable	boolean	*	True if Worker can be managed by Foreman
groups[]	array of objects (WorkerGroup)	*
gps_required	boolean	*	True if GPS in mobile is required
factory_credentials	object (WorkerFactoryCredentials)	*	@ORM\OneToOne(targetEntity="WorkerFactoryCredentials", mappedBy="worker" )
hourly_rate	float	*	Hourly rate, 2 decimal Number (0.00)
user	object (User)	*
roster_visibility	object (RosterVisibility)	*	Roster Visibility type
start_time	DateTime	*
stop_time	DateTime	*
worktype	object (Worktype)	*	Workers default workype
workplaces[]	array of objects (Workplace)	*
personal_code	string	*	Personal code or national personal id, up to 64 characters
is_personal_code_verified	boolean	*
calendar_events[]	array of objects (CalendarEvent)	*
qr	string	*	QR code This is copy of QrImage->QrText parameter for fast querying in lists
qr_image	object (QrImage)	*	QR Image
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

GET DEPRECATED /api/workers-credentials/{id}

Returns a Worker with its factory credentials

Documentation
Sandbox

Documentation

Returns a Worker with its factory credentials

Requirements

Name	Requirement	Type	Description
id		integer\|string	Worker 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 (factory). 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

PUT /api/workers/approvables/{id}

Replaces the set of Workers whose work this Worker may approve

Documentation
Sandbox

Documentation

Replaces the set of Workers whose work this Worker may approve. Returns the updated Worker

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Worker (approver) Id

Parameters

Parameter	Type	Required?	Format	Description
approvable_ids	array	true		Approvables ids array, [1, 2, ...]

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_boolean	boolean	*
crop_periods_visible_ids	array	*
pria_payee_ids	array	*
agrifield_ids	array	*
approvable_ids	array	*
approver_ids	array	*
brigade_member_ids	array	*
subordinate_ids	array	*
role_ids	array	*
roles_array	array	*	Worker app / My Profile uses this
classificator	string	*
color	string	*
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
profession	object (Profession)	*	Profession
boss	object (Worker)	*
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
subordinates[]	array of objects (Worker)	*
outer_id	string	*	Worker Id in external system, for example code in Accounting or Human Resources system.
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
company_type	object (CompanyType)	*	If workers type is different from Companies generic type
description	string	*
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
is_foreman_manageable	boolean	*	True if Worker can be managed by Foreman
gps_required	boolean	*	True if GPS in mobile is required
factory_credentials	object (WorkerFactoryCredentials)	*	@ORM\OneToOne(targetEntity="WorkerFactoryCredentials", mappedBy="worker" )
hourly_rate	float	*	Hourly rate, 2 decimal Number (0.00)
user	object (User)	*
roster_visibility	object (RosterVisibility)	*	Roster Visibility type
start_time	DateTime	*
stop_time	DateTime	*
worktype	object (Worktype)	*	Workers default workype
workplaces[]	array of objects (Workplace)	*
personal_code	string	*	Personal code or national personal id, up to 64 characters
is_personal_code_verified	boolean	*
calendar_events[]	array of objects (CalendarEvent)	*
qr	string	*	QR code This is copy of QrImage->QrText parameter for fast querying in lists
qr_image	object (QrImage)	*	QR Image
created_at_timestamp	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department

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/workers/brigade-members/{id}

Brigade members of one worker acting as foreman, by worker id.

Documentation
Sandbox

Documentation

Get Worker (foreman) brigade members

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Worker (foreman) Id

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 (classificator, 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
approver_ids	array	*
reversed_fullname	string	*
id	integer	*	Worker Id in Terake
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
boss	object (Worker)	*
groups[]	array of objects (WorkerGroup)	*
start_time	DateTime	*
stop_time	DateTime	*
workplaces[]	array of objects (Workplace)	*
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

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/workers/brigade-members/{id}

Replaces the brigade members of a Worker

Documentation
Sandbox

Documentation

Replaces the brigade members of a Worker. Returns the updated Worker

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Worker (foreman) Id

Parameters

Parameter	Type	Required?	Format	Description
brigade_member_ids	array<integer>	true		List of subordinate id's

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_boolean	boolean	*
crop_periods_visible_ids	array	*
pria_payee_ids	array	*
agrifield_ids	array	*
approvable_ids	array	*
approver_ids	array	*
brigade_member_ids	array	*
subordinate_ids	array	*
role_ids	array	*
roles_array	array	*	Worker app / My Profile uses this
classificator	string	*
color	string	*
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
profession	object (Profession)	*	Profession
boss	object (Worker)	*
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
subordinates[]	array of objects (Worker)	*
outer_id	string	*	Worker Id in external system, for example code in Accounting or Human Resources system.
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
company_type	object (CompanyType)	*	If workers type is different from Companies generic type
description	string	*
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
is_foreman_manageable	boolean	*	True if Worker can be managed by Foreman
gps_required	boolean	*	True if GPS in mobile is required
factory_credentials	object (WorkerFactoryCredentials)	*	@ORM\OneToOne(targetEntity="WorkerFactoryCredentials", mappedBy="worker" )
hourly_rate	float	*	Hourly rate, 2 decimal Number (0.00)
user	object (User)	*
roster_visibility	object (RosterVisibility)	*	Roster Visibility type
start_time	DateTime	*
stop_time	DateTime	*
worktype	object (Worktype)	*	Workers default workype
workplaces[]	array of objects (Workplace)	*
personal_code	string	*	Personal code or national personal id, up to 64 characters
is_personal_code_verified	boolean	*
calendar_events[]	array of objects (CalendarEvent)	*
qr	string	*	QR code This is copy of QrImage->QrText parameter for fast querying in lists
qr_image	object (QrImage)	*	QR Image
created_at_timestamp	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department

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/workers/brigade/realtime

Brigade member start or stop

Documentation
Sandbox

Documentation

Brigade member start or stop. Returns the brigade realtime rows, and an empty array when the caller is not a foreman

Parameters

Parameter	Type	Required?	Description
brigade_worker_id	integer	true	Brigade member id
worktype_id	integer	true	WorkType object id
action	string	true	start\|stop
groups	string	false	Comma-separated subset of the serializer groups this endpoint offers (default, 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.

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/workers/brigade/start

Start brigade workers work

Documentation
Sandbox

Documentation

Start brigade workers work. Returns an empty array on success

Parameters

Parameter	Type	Required?	Description
attrs	object	true	Work attributes applied to the whole brigade - worktype, main_facility, secondary_facility and workobject, each an object with an id field.
worker_ids	array	true	Brigade member ids
attrs[worktype][id]	integer	true	WorkType id
attrs[main_facility][id]	integer	true	Facility id
attrs[secondary_facility][id]	integer	true	Secondary facility id
attrs[workobject][id]	integer	true	Work object 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

PUT /api/workers/brigade/stop

Stop brigade workers work

Documentation
Sandbox

Documentation

Stop brigade workers work. Returns an empty array on success

Parameters

Parameter	Type	Required?	Description
brigade_worker_id	integer	true	Brigade member whose work is stopped.
worktype_id	integer	false	Worktype recorded on the stopped work.
worker_ids	array	true	Brigade member ids

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

PUT /api/workers/change_username/{id}

Change Worker username

Documentation
Sandbox

Documentation

Changes Worker username. Returns the stored username as { username: ... }

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Worker Id

Parameters

Parameter	Type	Required?	Format	Description
username	string	true		New username for 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.

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/workers/last-seen/{id}

Last recorded device access for one worker, by worker id or uuid: device model

Documentation
Sandbox

Documentation

Last recorded device access for one worker, by worker id or uuid: device model, OS and app version with the time last seen. Returns the worker's last access row, or null when they have never connected

Requirements

Name	Requirement	Type	Description
id		integer\|string	Worker 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.

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

PUT /api/workers/priapayees/{id}

Replaces the PRIA payees a Worker represents and the crop periods visible to them

Documentation
Sandbox

Documentation

Replaces the PRIA payees a Worker represents and the crop periods visible to them. Returns the updated Worker

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Pria worker Id

Parameters

Parameter	Type	Required?	Description
agrifield_ids	array of integers	true	Fields whose PRIA payee is set to the worker in the URL.
pria_payee_ids	array<integer>	true	List of Pria Payee id's
crop_periods_visible_ids	array<integer>	true	List of Crop Period id's

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_boolean	boolean	*
crop_periods_visible_ids	array	*
pria_payee_ids	array	*
agrifield_ids	array	*
approvable_ids	array	*
approver_ids	array	*
brigade_member_ids	array	*
subordinate_ids	array	*
role_ids	array	*
roles_array	array	*	Worker app / My Profile uses this
classificator	string	*
color	string	*
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
profession	object (Profession)	*	Profession
boss	object (Worker)	*
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
subordinates[]	array of objects (Worker)	*
outer_id	string	*	Worker Id in external system, for example code in Accounting or Human Resources system.
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
company_type	object (CompanyType)	*	If workers type is different from Companies generic type
description	string	*
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
is_foreman_manageable	boolean	*	True if Worker can be managed by Foreman
gps_required	boolean	*	True if GPS in mobile is required
factory_credentials	object (WorkerFactoryCredentials)	*	@ORM\OneToOne(targetEntity="WorkerFactoryCredentials", mappedBy="worker" )
hourly_rate	float	*	Hourly rate, 2 decimal Number (0.00)
user	object (User)	*
roster_visibility	object (RosterVisibility)	*	Roster Visibility type
start_time	DateTime	*
stop_time	DateTime	*
worktype	object (Worktype)	*	Workers default workype
workplaces[]	array of objects (Workplace)	*
personal_code	string	*	Personal code or national personal id, up to 64 characters
is_personal_code_verified	boolean	*
calendar_events[]	array of objects (CalendarEvent)	*
qr	string	*	QR code This is copy of QrImage->QrText parameter for fast querying in lists
qr_image	object (QrImage)	*	QR Image
created_at_timestamp	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department

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/workers/setpassword/{id}

Sets a new password for a Worker

Documentation
Sandbox

Documentation

Sets a new password for a Worker. Send password1 and password2, or a password_change object holding both. An admin may target another Worker; anyone else may only change their own. Returns the updated Worker, or an error slug such as alert.not_allowed

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Worker Id

Parameters

Parameter	Type	Required?	Description
password1	string	false	New password. Sent flat, or inside password_change.
password2	string	false	New password repeated. Sent flat, or inside password_change.
password_change	object	false	New password as an object with password1 and password2 fields. Used when the flat fields are absent.
password_change[password1]	string	true	Password
password_change[password2]	string	true	Password repeat

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_boolean	boolean	*
crop_periods_visible_ids	array	*
pria_payee_ids	array	*
agrifield_ids	array	*
approvable_ids	array	*
approver_ids	array	*
brigade_member_ids	array	*
subordinate_ids	array	*
role_ids	array	*
roles_array	array	*	Worker app / My Profile uses this
classificator	string	*
color	string	*
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
profession	object (Profession)	*	Profession
boss	object (Worker)	*
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
subordinates[]	array of objects (Worker)	*
outer_id	string	*	Worker Id in external system, for example code in Accounting or Human Resources system.
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
company_type	object (CompanyType)	*	If workers type is different from Companies generic type
description	string	*
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
is_foreman_manageable	boolean	*	True if Worker can be managed by Foreman
groups[]	array of objects (WorkerGroup)	*
gps_required	boolean	*	True if GPS in mobile is required
factory_credentials	object (WorkerFactoryCredentials)	*	@ORM\OneToOne(targetEntity="WorkerFactoryCredentials", mappedBy="worker" )
hourly_rate	float	*	Hourly rate, 2 decimal Number (0.00)
user	object (User)	*
roster_visibility	object (RosterVisibility)	*	Roster Visibility type
start_time	DateTime	*
stop_time	DateTime	*
worktype	object (Worktype)	*	Workers default workype
workplaces[]	array of objects (Workplace)	*
personal_code	string	*	Personal code or national personal id, up to 64 characters
is_personal_code_verified	boolean	*
calendar_events[]	array of objects (CalendarEvent)	*
qr	string	*	QR code This is copy of QrImage->QrText parameter for fast querying in lists
qr_image	object (QrImage)	*	QR Image
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/workers/setroles/{id}

Replaces the roles of a Worker

Documentation
Sandbox

Documentation

Replaces the roles of a Worker. Globally scoped roles are never removed, and only ROLE_ADMIN may grant or revoke ROLE_ADMIN. Returns the updated Worker, or { error: alert.not_allowed }

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Worker Id

Parameters

Parameter	Type	Required?	Format	Description
role_ids	array	true		Array of role id's

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_boolean	boolean	*
crop_periods_visible_ids	array	*
pria_payee_ids	array	*
agrifield_ids	array	*
approvable_ids	array	*
approver_ids	array	*
brigade_member_ids	array	*
subordinate_ids	array	*
role_ids	array	*
roles_array	array	*	Worker app / My Profile uses this
classificator	string	*
color	string	*
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
profession	object (Profession)	*	Profession
boss	object (Worker)	*
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
subordinates[]	array of objects (Worker)	*
outer_id	string	*	Worker Id in external system, for example code in Accounting or Human Resources system.
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
company_type	object (CompanyType)	*	If workers type is different from Companies generic type
description	string	*
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
is_foreman_manageable	boolean	*	True if Worker can be managed by Foreman
gps_required	boolean	*	True if GPS in mobile is required
factory_credentials	object (WorkerFactoryCredentials)	*	@ORM\OneToOne(targetEntity="WorkerFactoryCredentials", mappedBy="worker" )
hourly_rate	float	*	Hourly rate, 2 decimal Number (0.00)
user	object (User)	*
roster_visibility	object (RosterVisibility)	*	Roster Visibility type
start_time	DateTime	*
stop_time	DateTime	*
worktype	object (Worktype)	*	Workers default workype
workplaces[]	array of objects (Workplace)	*
personal_code	string	*	Personal code or national personal id, up to 64 characters
is_personal_code_verified	boolean	*
calendar_events[]	array of objects (CalendarEvent)	*
qr	string	*	QR code This is copy of QrImage->QrText parameter for fast querying in lists
qr_image	object (QrImage)	*	QR Image
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

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/workers/{id}

Delete Worker by ID or UUID

Documentation
Sandbox

Documentation

Deletes Worker by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer	Worker id

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		Worker 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
is_active_boolean	boolean	*
crop_periods_visible_ids	array	*
pria_payee_ids	array	*
agrifield_ids	array	*
approvable_ids	array	*
approver_ids	array	*
brigade_member_ids	array	*
subordinate_ids	array	*
role_ids	array	*
roles_array	array	*	Worker app / My Profile uses this
classificator	string	*
color	string	*
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
profession	object (Profession)	*	Profession
boss	object (Worker)	*
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
subordinates[]	array of objects (Worker)	*
outer_id	string	*	Worker Id in external system, for example code in Accounting or Human Resources system.
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
company_type	object (CompanyType)	*	If workers type is different from Companies generic type
description	string	*
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
is_foreman_manageable	boolean	*	True if Worker can be managed by Foreman
groups[]	array of objects (WorkerGroup)	*
gps_required	boolean	*	True if GPS in mobile is required
factory_credentials	object (WorkerFactoryCredentials)	*	@ORM\OneToOne(targetEntity="WorkerFactoryCredentials", mappedBy="worker" )
hourly_rate	float	*	Hourly rate, 2 decimal Number (0.00)
user	object (User)	*
roster_visibility	object (RosterVisibility)	*	Roster Visibility type
start_time	DateTime	*
stop_time	DateTime	*
worktype	object (Worktype)	*	Workers default workype
workplaces[]	array of objects (Workplace)	*
personal_code	string	*	Personal code or national personal id, up to 64 characters
is_personal_code_verified	boolean	*
calendar_events[]	array of objects (CalendarEvent)	*
qr	string	*	QR code This is copy of QrImage->QrText parameter for fast querying in lists
qr_image	object (QrImage)	*	QR Image
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

GET /api/workers/{id}

Worker by ID or UUID.

Documentation
Sandbox

Documentation

Returns Worker by ID or UUID.

Requirements

Name	Requirement	Type	Description
id		integer	Worker id

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		Worker uuid
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (worker, workerlist, baseattribute, classificator, calendarevent, 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
is_active_boolean	boolean	*
crop_periods_visible_ids	array	*
pria_payee_ids	array	*
agrifield_ids	array	*
approvable_ids	array	*
approver_ids	array	*
brigade_member_ids	array	*
subordinate_ids	array	*
role_ids	array	*
roles_array	array	*	Worker app / My Profile uses this
classificator	string	*
color	string	*
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
profession	object (Profession)	*	Profession
boss	object (Worker)	*
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
subordinates[]	array of objects (Worker)	*
outer_id	string	*	Worker Id in external system, for example code in Accounting or Human Resources system.
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
company_type	object (CompanyType)	*	If workers type is different from Companies generic type
description	string	*
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
is_foreman_manageable	boolean	*	True if Worker can be managed by Foreman
groups[]	array of objects (WorkerGroup)	*
gps_required	boolean	*	True if GPS in mobile is required
factory_credentials	object (WorkerFactoryCredentials)	*	@ORM\OneToOne(targetEntity="WorkerFactoryCredentials", mappedBy="worker" )
hourly_rate	float	*	Hourly rate, 2 decimal Number (0.00)
user	object (User)	*
roster_visibility	object (RosterVisibility)	*	Roster Visibility type
start_time	DateTime	*
stop_time	DateTime	*
worktype	object (Worktype)	*	Workers default workype
workplaces[]	array of objects (Workplace)	*
personal_code	string	*	Personal code or national personal id, up to 64 characters
is_personal_code_verified	boolean	*
calendar_events[]	array of objects (CalendarEvent)	*
qr	string	*	QR code This is copy of QrImage->QrText parameter for fast querying in lists
qr_image	object (QrImage)	*	QR Image
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/workers/{id}

Modify Worker

Documentation
Sandbox

Documentation

Modify Worker

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Worker Id

Parameters

Parameter	Type	Required?	Format	Description
id	integer	true		Id of the record being updated. Must match the id in the URL.
firstname	string	false		Truncated to 250 characters.
lastname	string	false		Truncated to 250 characters.
email	string	false		Truncated to 200 characters.
phone	string	false		Truncated to 25 characters.
outer_id	string	false		Truncated to 40 characters.
description	string	false		Truncated to 255 characters.
profession	object	false		Reference to Profession. Send { "id": <id> }, or null to clear.
facility	object	false		Reference to Facility. Send { "id": <id> }, or null to clear.
worktype	object	false		Reference to Worktype. Send { "id": <id> }, or null to clear.
boss	object	false		Reference to Worker. Send { "id": <id> }, or null to clear.
company_type	object	false		Reference to CompanyType. Send { "id": <id> }, or null to clear.
time_tracking_type	object	false		Reference to TimeTrackingType. Send { "id": <id> }, or null to clear.
gps_tracking_interval	integer	false
is_archived	boolean	false
is_foreman_manageable	boolean	false		Stored as 1 or 0.
department	object	false		Reference to Department. Send { "id": <id> }, or null to clear.
gps_required	boolean	false
hourly_rate	float	false		Decimal comma is accepted.
roster_visibility	object	false		Reference to RosterVisibility. Send { "id": <id> }, or null to clear.
start_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value clears the field. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
stop_time	datetime	false	Y-m-d H:i:s	Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00. An empty value clears the field. Read in the company time zone. Any string PHP can parse is accepted, but a slash-separated date is read US-first, so send Y-m-d H:i:s.
is_personal_code_verified	boolean	false
personal_code	string	false
modification_start_time	datetime	false	YYYY-MM-DD HH:MM:SS	Start of the period the change applies from. Defaults to 1970-01-01. Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00.

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_boolean	boolean	*
crop_periods_visible_ids	array	*
pria_payee_ids	array	*
agrifield_ids	array	*
approvable_ids	array	*
approver_ids	array	*
brigade_member_ids	array	*
subordinate_ids	array	*
role_ids	array	*
roles_array	array	*	Worker app / My Profile uses this
classificator	string	*
color	string	*
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
profession	object (Profession)	*	Profession
boss	object (Worker)	*
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
subordinates[]	array of objects (Worker)	*
outer_id	string	*	Worker Id in external system, for example code in Accounting or Human Resources system.
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
company_type	object (CompanyType)	*	If workers type is different from Companies generic type
description	string	*
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
is_foreman_manageable	boolean	*	True if Worker can be managed by Foreman
gps_required	boolean	*	True if GPS in mobile is required
factory_credentials	object (WorkerFactoryCredentials)	*	@ORM\OneToOne(targetEntity="WorkerFactoryCredentials", mappedBy="worker" )
hourly_rate	float	*	Hourly rate, 2 decimal Number (0.00)
user	object (User)	*
roster_visibility	object (RosterVisibility)	*	Roster Visibility type
start_time	DateTime	*
stop_time	DateTime	*
worktype	object (Worktype)	*	Workers default workype
workplaces[]	array of objects (Workplace)	*
personal_code	string	*	Personal code or national personal id, up to 64 characters
is_personal_code_verified	boolean	*
calendar_events[]	array of objects (CalendarEvent)	*
qr	string	*	QR code This is copy of QrImage->QrText parameter for fast querying in lists
qr_image	object (QrImage)	*	QR Image
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

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/workersearch/{q}

Searches the Workers visible to the caller by name

Documentation
Sandbox

Documentation

Searches the Workers visible to the caller by name

Requirements

Name	Requirement	Type	Description
q

Parameters

Parameter	Type	Required?	Format	Description
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (worker, workerlist, baseattribute, classificator, owner). 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_boolean	boolean	*
crop_periods_visible_ids	array	*
pria_payee_ids	array	*
agrifield_ids	array	*
approvable_ids	array	*
approver_ids	array	*
brigade_member_ids	array	*
subordinate_ids	array	*
role_ids	array	*
roles_array	array	*	Worker app / My Profile uses this
classificator	string	*
color	string	*
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
email	string	*	Worker e-mail address.
username	string	*	Worker username, auto-generated by Terake
phone	string	*	Person phone number
profession	object (Profession)	*	Profession
boss	object (Worker)	*
rolecollection[]	array of objects (Role)	*
facility	object (Facility)	*	Workers main facility
subordinates[]	array of objects (Worker)	*
outer_id	string	*	Worker Id in external system, for example code in Accounting or Human Resources system.
gps_tracking_interval	integer	*	GPS tracking interval in minutes, integer
company_type	object (CompanyType)	*	If workers type is different from Companies generic type
description	string	*
time_tracking_type	object (TimeTrackingType)	*	Time tracking type
is_foreman_manageable	boolean	*	True if Worker can be managed by Foreman
groups[]	array of objects (WorkerGroup)	*
gps_required	boolean	*	True if GPS in mobile is required
factory_credentials	object (WorkerFactoryCredentials)	*	@ORM\OneToOne(targetEntity="WorkerFactoryCredentials", mappedBy="worker" )
hourly_rate	float	*	Hourly rate, 2 decimal Number (0.00)
user	object (User)	*
roster_visibility	object (RosterVisibility)	*	Roster Visibility type
start_time	DateTime	*
stop_time	DateTime	*
worktype	object (Worktype)	*	Workers default workype
workplaces[]	array of objects (Workplace)	*
personal_code	string	*	Personal code or national personal id, up to 64 characters
is_personal_code_verified	boolean	*
calendar_events[]	array of objects (CalendarEvent)	*
qr	string	*	QR code This is copy of QrImage->QrText parameter for fast querying in lists
qr_image	object (QrImage)	*	QR Image
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

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/workplace/{id}

Modifies a Workplace

Documentation
Sandbox

Documentation

Modifies a Workplace. Returns the updated Worker, or an error slug

Requirements

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

Parameters

Parameter	Type	Required?	Format	Description
worker_id	integer	false		Worker the workplace belongs to
start_time	datetime	false	YYYY-MM-DD HH:MM:SS	When the workplace assignment starts. Date and time as Y-m-d H:i:s, for example 2026-08-28 14:30:00.

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

WorkobjectCategories

A workobject category distinguishes the kinds of object work is done on - a field, a yard, a building, a road. Category decides which rules apply: only fields carry crop data and PRIA obligations. These endpoints create, edit, archive and delete categories. The list is shared with partner companies and archived in two levels. Category 10 is the default for a workobject created without one.

GET /api/workobjectcategories

WorkobjectCategory collection

Documentation
Sandbox

Documentation

Returns WorkobjectCategory 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 (workobject_category, owner, 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
200
fullname	string	*
id	integer	*
name	string	*
slug	string	*
company	object (Company)	*
inspection_master_template	object (InspectionMasterTemplate)	*
archives[]	array of objects (WorkobjectCategoryArchive)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	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/workobjectcategories

Create new WorkobjectCategory

Documentation
Sandbox

Documentation

Creates new WorkobjectCategory

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
inspection_master_template	object	false	Reference to InspectionMasterTemplate. 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
200
fullname	string	*
id	integer	*
name	string	*
slug	string	*
company	object (Company)	*
inspection_master_template	object (InspectionMasterTemplate)	*
archives[]	array of objects (WorkobjectCategoryArchive)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/workobjectcategories/{id}

Delete WorkobjectCategory by ID or UUID

Documentation
Sandbox

Documentation

Deletes WorkobjectCategory by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	WorkobjectCategory 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
200
fullname	string	*
id	integer	*
name	string	*
slug	string	*
company	object (Company)	*
inspection_master_template	object (InspectionMasterTemplate)	*
archives[]	array of objects (WorkobjectCategoryArchive)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/workobjectcategories/{id}

WorkobjectCategory by ID or UUID

Documentation
Sandbox

Documentation

Returns WorkobjectCategory by ID or UUID

Requirements

Name	Requirement	Type	Description
id		integer\|string	WorkobjectCategory 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 (workobject_category, owner, 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
200
fullname	string	*
id	integer	*
name	string	*
slug	string	*
company	object (Company)	*
inspection_master_template	object (InspectionMasterTemplate)	*
archives[]	array of objects (WorkobjectCategoryArchive)	*
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/workobjectcategories/{id}

Modify WorkobjectCategory

Documentation
Sandbox

Documentation

Modify WorkobjectCategory

Requirements

Name	Requirement	Type	Description
id		integer\|string	WorkobjectCategory 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
inspection_master_template	object	false	Reference to InspectionMasterTemplate. 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
200
fullname	string	*
id	integer	*
name	string	*
slug	string	*
company	object (Company)	*
inspection_master_template	object (InspectionMasterTemplate)	*
archives[]	array of objects (WorkobjectCategoryArchive)	*
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/workobjectcategories/{id}/togglearchive

Toggle Archive/Un-archive WorkobjectCategory

Documentation
Sandbox

Documentation

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

Requirements

Name	Requirement	Type	Description
id		integer\|string	WorkobjectCategory 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
200
fullname	string	*
id	integer	*
name	string	*
slug	string	*
company	object (Company)	*
inspection_master_template	object (InspectionMasterTemplate)	*
archives[]	array of objects (WorkobjectCategoryArchive)	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*

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

Workobjects

A Workobject is anything work is carried out on. It shares its entity with Agrifield, so a field is a workobject with crop data and a yard is a workobject without. These endpoints create and edit workobjects, attach them to cadastral units and read their crop rotation and statistics. The workobjectsonly routes address the same records without the field specific data. Which behaviour applies is decided by the workobject category.

DELETE /api/agrifield_data/{crop_period_id}/{id}

Delete Workobject

Documentation
Sandbox

Documentation

Delete Workobject by ID or UUID

Requirements

Name	Requirement	Type	Description
crop_period_id		integer\|string	CropPeriod id, usually the year (e.g. 2026)
id	\d+	integer	Workobject id

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		Workobject 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	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
crop_period	object (CropPeriod)	*
workobject_category	object (WorkobjectCategory)	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
pria_uuid	string	*
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

POST /api/agrifields

Creates or modifies a Workobject

Documentation
Sandbox

Documentation

Creates a new Workobject, or modifies the one named in the URL. The workobjectsonly and agrifields routes serve the same entity; a new record with no workobject_category defaults to category 10

Requirements

Name	Requirement	Type	Description
id		integer\|string	Workobject 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.
name	string	true
massive_number	string	false
cadastre_number	string	false
field_number	string	false
location_address	string	false
outer_id	string	false	Identifier in the source system.
location_region	string	false
location_area	object	false	Reference to LocationArea. Send { "id": <id> }, or null to clear.
workobject_category	object	false	Reference to WorkobjectCategory. Send { "id": <id> }, or null to clear.
customer	object	false	Reference to Customer. Send { "id": <id> }, or null to clear.
department	object	false	Reference to Department. Send { "id": <id> }, or null to clear.
responsible_worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
second_worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
inspection_schedule	object	false	Reference to InspectionMasterTemplate. Send { "id": <id> }, or null to clear.
is_archived	boolean	false
is_storage	boolean	false
is_hidden_for_fieldbook	boolean	false
lat	float	false	Latitude of the workobject centroid.
lng	float	false	Longitude of the workobject centroid.
cadastres	array of objects	false	Cadastres to relate to a newly created workobject. Objects with an id field. Read only when the workobject is created.
geo_item	object	false	Geometry of the workobject, as an object with a geojson field holding a geometry. Sending no geo_item removes the existing geometry.
crop_period	integer\|object	false	Crop period to open for the field, as an id such as 2026 or an object with an id field. Read only when at least one of field_size, crop, crop_name or crop_variety is also sent; an unknown or missing value means the current year.
field_size	float	false	Field size in hectares for the crop period. Sending it opens the crop period for the field. Decimal comma is accepted.
crop	object	false	Crop grown in the crop period, as { "id": <id> }. Sending it opens the crop period for the field.
crop_name	string	false	Crop grown in the crop period, by name. Matched against the company's crops and the shared crop list; an unknown name creates a crop. Ignored when crop is sent. Sending it opens the crop period for the field.
crop_variety	string	false	Crop variety for the crop period. Sending it opens the crop period for the field.

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
lat	float	*
lng	float	*
classificator	string	*
color	string	*
agrifield_pria_history_data_narrow	array	*
__field_number_sortable	string	*
rowclass	string	*
responsible_worker	object (Worker)	*	Person responsible for solving issues, faults and problems
partner_ids	array	*
id	integer	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
massive_number	string	*
field_number	string	*
field_size	float	*
water_protection_area_size	float	*
field_usage_description	string	*
location_county	string	*
location_parish	string	*
pria_payee	object (PriaPayee)	*
crop_period	object (CropPeriod)	*
agrifield_data[]	array of objects (AgrifieldData)	*
outer_id	string	*
is_hidden_for_fieldbook	boolean	*
workobject_category	object (WorkobjectCategory)	*
groups[]	array of objects (AgrifieldGroup)	*
location_region	string	*
location_address	string	*
crop	object (Crop)	*
crop_variety	string	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
master_agrifield	object (Agrifield)	*
merged_agrifields[]	array of objects (Agrifield)	*
merged_from_crop_period	object (CropPeriod)	*
is_water_protection_active	boolean	*
geo_item	object (GeoItem)	*
_geom_updated_at_timestamp	integer	*
second_worker	object (Worker)	*	Second responsible person
is_storage	boolean	*
agreement	object (Agreement)	*
agreement_objects[]	array of objects (AgreementObject)	*
inspection_schedule	object (InspectionMasterTemplate)	*	Inspection schedule
fault_severity	integer	*
pria_uuid	string	*
cadastres[]	array of objects (Cadastre)	*
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

GET /api/agrifields/{id}

Get Workobject

Documentation
Sandbox

Documentation

Returns Workobject by ID or UUID

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Workobject id

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		Workobject uuid
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (agrifields, agrifield_all, workobject, geo, owner, sharing, baseattribute, classificator, auditcolumns, fieldbook). 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
lat	float	*
lng	float	*
classificator	string	*
color	string	*
agrifield_pria_history_data_narrow	array	*
__field_number_sortable	string	*
rowclass	string	*
responsible_worker	object (Worker)	*	Person responsible for solving issues, faults and problems
partner_ids	array	*
id	integer	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
massive_number	string	*
field_number	string	*
field_size	float	*
water_protection_area_size	float	*
field_usage_description	string	*
location_county	string	*
location_parish	string	*
pria_payee	object (PriaPayee)	*
crop_period	object (CropPeriod)	*
agrifield_data[]	array of objects (AgrifieldData)	*
outer_id	string	*
is_hidden_for_fieldbook	boolean	*
workobject_category	object (WorkobjectCategory)	*
groups[]	array of objects (AgrifieldGroup)	*
location_region	string	*
location_address	string	*
crop	object (Crop)	*
crop_variety	string	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
master_agrifield	object (Agrifield)	*
merged_agrifields[]	array of objects (Agrifield)	*
merged_from_crop_period	object (CropPeriod)	*
is_water_protection_active	boolean	*
geo_item	object (GeoItem)	*
_geom_updated_at_timestamp	integer	*
second_worker	object (Worker)	*	Second responsible person
is_storage	boolean	*
agreement	object (Agreement)	*
agreement_objects[]	array of objects (AgreementObject)	*
inspection_schedule	object (InspectionMasterTemplate)	*	Inspection schedule
fault_severity	integer	*
pria_uuid	string	*
cadastres[]	array of objects (Cadastre)	*
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/agrifields/{id}

Creates or modifies a Workobject

Documentation
Sandbox

Documentation

Creates a new Workobject, or modifies the one named in the URL. The workobjectsonly and agrifields routes serve the same entity; a new record with no workobject_category defaults to category 10

Requirements

Name	Requirement	Type	Description
id		integer\|string	Workobject 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	true
massive_number	string	false
cadastre_number	string	false
field_number	string	false
location_address	string	false
outer_id	string	false	Identifier in the source system.
location_region	string	false
location_area	object	false	Reference to LocationArea. Send { "id": <id> }, or null to clear.
workobject_category	object	false	Reference to WorkobjectCategory. Send { "id": <id> }, or null to clear.
customer	object	false	Reference to Customer. Send { "id": <id> }, or null to clear.
department	object	false	Reference to Department. Send { "id": <id> }, or null to clear.
responsible_worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
second_worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
inspection_schedule	object	false	Reference to InspectionMasterTemplate. Send { "id": <id> }, or null to clear.
is_archived	boolean	false
is_storage	boolean	false
is_hidden_for_fieldbook	boolean	false
lat	float	false	Latitude of the workobject centroid.
lng	float	false	Longitude of the workobject centroid.
cadastres	array of objects	false	Cadastres to relate to a newly created workobject. Objects with an id field. Read only when the workobject is created.
geo_item	object	false	Geometry of the workobject, as an object with a geojson field holding a geometry. Sending no geo_item removes the existing geometry.
crop_period	integer\|object	false	Crop period to open for the field, as an id such as 2026 or an object with an id field. Read only when at least one of field_size, crop, crop_name or crop_variety is also sent; an unknown or missing value means the current year.
field_size	float	false	Field size in hectares for the crop period. Sending it opens the crop period for the field. Decimal comma is accepted.
crop	object	false	Crop grown in the crop period, as { "id": <id> }. Sending it opens the crop period for the field.
crop_name	string	false	Crop grown in the crop period, by name. Matched against the company's crops and the shared crop list; an unknown name creates a crop. Ignored when crop is sent. Sending it opens the crop period for the field.
crop_variety	string	false	Crop variety for the crop period. Sending it opens the crop period for the field.

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
lat	float	*
lng	float	*
classificator	string	*
color	string	*
agrifield_pria_history_data_narrow	array	*
__field_number_sortable	string	*
rowclass	string	*
responsible_worker	object (Worker)	*	Person responsible for solving issues, faults and problems
partner_ids	array	*
id	integer	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
massive_number	string	*
field_number	string	*
field_size	float	*
water_protection_area_size	float	*
field_usage_description	string	*
location_county	string	*
location_parish	string	*
pria_payee	object (PriaPayee)	*
crop_period	object (CropPeriod)	*
agrifield_data[]	array of objects (AgrifieldData)	*
outer_id	string	*
is_hidden_for_fieldbook	boolean	*
workobject_category	object (WorkobjectCategory)	*
groups[]	array of objects (AgrifieldGroup)	*
location_region	string	*
location_address	string	*
crop	object (Crop)	*
crop_variety	string	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
master_agrifield	object (Agrifield)	*
merged_agrifields[]	array of objects (Agrifield)	*
merged_from_crop_period	object (CropPeriod)	*
is_water_protection_active	boolean	*
geo_item	object (GeoItem)	*
_geom_updated_at_timestamp	integer	*
second_worker	object (Worker)	*	Second responsible person
is_storage	boolean	*
agreement	object (Agreement)	*
agreement_objects[]	array of objects (AgreementObject)	*
inspection_schedule	object (InspectionMasterTemplate)	*	Inspection schedule
fault_severity	integer	*
pria_uuid	string	*
cadastres[]	array of objects (Cadastre)	*
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

GET /api/geometry/workobjects

Workobject geometries for the map.

Documentation
Sandbox

Documentation

Returns Workobjects Geometries 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 (geo_simple). 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
lat	float	*
lng	float	*
id	integer	*	Workobject id in Terake
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
geo_item	object (GeoItem)	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/workobjects

All Workobjects list

Documentation
Sandbox

Documentation

Returns all Workobjects list

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 (owner, agrifield_all, baseattribute, classificator). 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
lat	float	*
lng	float	*
classificator	string	*
__field_number_sortable	string	*
rowclass	string	*
responsible_worker	object (Worker)	*	Person responsible for solving issues, faults and problems
id	integer	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
massive_number	string	*
field_number	string	*
field_size	float	*
water_protection_area_size	float	*
field_usage_description	string	*
location_county	string	*
location_parish	string	*
pria_payee	object (PriaPayee)	*
crop_period	object (CropPeriod)	*
outer_id	string	*
is_hidden_for_fieldbook	boolean	*
workobject_category	object (WorkobjectCategory)	*
groups[]	array of objects (AgrifieldGroup)	*
location_region	string	*
location_address	string	*
crop	object (Crop)	*
crop_variety	string	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
master_agrifield	object (Agrifield)	*
merged_agrifields[]	array of objects (Agrifield)	*
merged_from_crop_period	object (CropPeriod)	*
is_water_protection_active	boolean	*
_geom_updated_at_timestamp	integer	*
second_worker	object (Worker)	*	Second responsible person
is_storage	boolean	*
fault_severity	integer	*
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/workobjects

Creates or modifies a Workobject

Documentation
Sandbox

Documentation

Creates a new Workobject, or modifies the one named in the URL. The workobjectsonly and agrifields routes serve the same entity; a new record with no workobject_category defaults to category 10

Requirements

Name	Requirement	Type	Description
id		integer\|string	Workobject 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.
name	string	true
massive_number	string	false
cadastre_number	string	false
field_number	string	false
location_address	string	false
outer_id	string	false	Identifier in the source system.
location_region	string	false
location_area	object	false	Reference to LocationArea. Send { "id": <id> }, or null to clear.
workobject_category	object	false	Reference to WorkobjectCategory. Send { "id": <id> }, or null to clear.
customer	object	false	Reference to Customer. Send { "id": <id> }, or null to clear.
department	object	false	Reference to Department. Send { "id": <id> }, or null to clear.
responsible_worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
second_worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
inspection_schedule	object	false	Reference to InspectionMasterTemplate. Send { "id": <id> }, or null to clear.
is_archived	boolean	false
is_storage	boolean	false
is_hidden_for_fieldbook	boolean	false
lat	float	false	Latitude of the workobject centroid.
lng	float	false	Longitude of the workobject centroid.
cadastres	array of objects	false	Cadastres to relate to a newly created workobject. Objects with an id field. Read only when the workobject is created.
geo_item	object	false	Geometry of the workobject, as an object with a geojson field holding a geometry. Sending no geo_item removes the existing geometry.
crop_period	integer\|object	false	Crop period to open for the field, as an id such as 2026 or an object with an id field. Read only when at least one of field_size, crop, crop_name or crop_variety is also sent; an unknown or missing value means the current year.
field_size	float	false	Field size in hectares for the crop period. Sending it opens the crop period for the field. Decimal comma is accepted.
crop	object	false	Crop grown in the crop period, as { "id": <id> }. Sending it opens the crop period for the field.
crop_name	string	false	Crop grown in the crop period, by name. Matched against the company's crops and the shared crop list; an unknown name creates a crop. Ignored when crop is sent. Sending it opens the crop period for the field.
crop_variety	string	false	Crop variety for the crop period. Sending it opens the crop period for the field.

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
lat	float	*
lng	float	*
classificator	string	*
color	string	*
agrifield_pria_history_data_narrow	array	*
__field_number_sortable	string	*
rowclass	string	*
responsible_worker	object (Worker)	*	Person responsible for solving issues, faults and problems
partner_ids	array	*
id	integer	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
massive_number	string	*
field_number	string	*
field_size	float	*
water_protection_area_size	float	*
field_usage_description	string	*
location_county	string	*
location_parish	string	*
pria_payee	object (PriaPayee)	*
crop_period	object (CropPeriod)	*
agrifield_data[]	array of objects (AgrifieldData)	*
outer_id	string	*
is_hidden_for_fieldbook	boolean	*
workobject_category	object (WorkobjectCategory)	*
groups[]	array of objects (AgrifieldGroup)	*
location_region	string	*
location_address	string	*
crop	object (Crop)	*
crop_variety	string	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
master_agrifield	object (Agrifield)	*
merged_agrifields[]	array of objects (Agrifield)	*
merged_from_crop_period	object (CropPeriod)	*
is_water_protection_active	boolean	*
geo_item	object (GeoItem)	*
_geom_updated_at_timestamp	integer	*
second_worker	object (Worker)	*	Second responsible person
is_storage	boolean	*
agreement	object (Agreement)	*
agreement_objects[]	array of objects (AgreementObject)	*
inspection_schedule	object (InspectionMasterTemplate)	*	Inspection schedule
fault_severity	integer	*
pria_uuid	string	*
cadastres[]	array of objects (Cadastre)	*
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

DELETE /api/workobjects/{id}

Delete Workobject

Documentation
Sandbox

Documentation

Delete Workobject by ID or UUID

Requirements

Name	Requirement	Type	Description
crop_period_id		integer\|string	CropPeriod id, usually the year (e.g. 2026)
id	\d+	integer	Workobject id

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		Workobject 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	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
crop_period	object (CropPeriod)	*
workobject_category	object (WorkobjectCategory)	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
pria_uuid	string	*
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

GET /api/workobjects/{id}

Get Workobject

Documentation
Sandbox

Documentation

Returns Workobject by ID or UUID

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Workobject id

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		Workobject uuid
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (agrifields, agrifield_all, workobject, geo, owner, sharing, baseattribute, classificator, auditcolumns, fieldbook). 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
lat	float	*
lng	float	*
classificator	string	*
color	string	*
agrifield_pria_history_data_narrow	array	*
__field_number_sortable	string	*
rowclass	string	*
responsible_worker	object (Worker)	*	Person responsible for solving issues, faults and problems
partner_ids	array	*
id	integer	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
massive_number	string	*
field_number	string	*
field_size	float	*
water_protection_area_size	float	*
field_usage_description	string	*
location_county	string	*
location_parish	string	*
pria_payee	object (PriaPayee)	*
crop_period	object (CropPeriod)	*
agrifield_data[]	array of objects (AgrifieldData)	*
outer_id	string	*
is_hidden_for_fieldbook	boolean	*
workobject_category	object (WorkobjectCategory)	*
groups[]	array of objects (AgrifieldGroup)	*
location_region	string	*
location_address	string	*
crop	object (Crop)	*
crop_variety	string	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
master_agrifield	object (Agrifield)	*
merged_agrifields[]	array of objects (Agrifield)	*
merged_from_crop_period	object (CropPeriod)	*
is_water_protection_active	boolean	*
geo_item	object (GeoItem)	*
_geom_updated_at_timestamp	integer	*
second_worker	object (Worker)	*	Second responsible person
is_storage	boolean	*
agreement	object (Agreement)	*
agreement_objects[]	array of objects (AgreementObject)	*
inspection_schedule	object (InspectionMasterTemplate)	*	Inspection schedule
fault_severity	integer	*
pria_uuid	string	*
cadastres[]	array of objects (Cadastre)	*
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/workobjects/{id}

Creates or modifies a Workobject

Documentation
Sandbox

Documentation

Creates a new Workobject, or modifies the one named in the URL. The workobjectsonly and agrifields routes serve the same entity; a new record with no workobject_category defaults to category 10

Requirements

Name	Requirement	Type	Description
id		integer\|string	Workobject 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	true
massive_number	string	false
cadastre_number	string	false
field_number	string	false
location_address	string	false
outer_id	string	false	Identifier in the source system.
location_region	string	false
location_area	object	false	Reference to LocationArea. Send { "id": <id> }, or null to clear.
workobject_category	object	false	Reference to WorkobjectCategory. Send { "id": <id> }, or null to clear.
customer	object	false	Reference to Customer. Send { "id": <id> }, or null to clear.
department	object	false	Reference to Department. Send { "id": <id> }, or null to clear.
responsible_worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
second_worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
inspection_schedule	object	false	Reference to InspectionMasterTemplate. Send { "id": <id> }, or null to clear.
is_archived	boolean	false
is_storage	boolean	false
is_hidden_for_fieldbook	boolean	false
lat	float	false	Latitude of the workobject centroid.
lng	float	false	Longitude of the workobject centroid.
cadastres	array of objects	false	Cadastres to relate to a newly created workobject. Objects with an id field. Read only when the workobject is created.
geo_item	object	false	Geometry of the workobject, as an object with a geojson field holding a geometry. Sending no geo_item removes the existing geometry.
crop_period	integer\|object	false	Crop period to open for the field, as an id such as 2026 or an object with an id field. Read only when at least one of field_size, crop, crop_name or crop_variety is also sent; an unknown or missing value means the current year.
field_size	float	false	Field size in hectares for the crop period. Sending it opens the crop period for the field. Decimal comma is accepted.
crop	object	false	Crop grown in the crop period, as { "id": <id> }. Sending it opens the crop period for the field.
crop_name	string	false	Crop grown in the crop period, by name. Matched against the company's crops and the shared crop list; an unknown name creates a crop. Ignored when crop is sent. Sending it opens the crop period for the field.
crop_variety	string	false	Crop variety for the crop period. Sending it opens the crop period for the field.

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
lat	float	*
lng	float	*
classificator	string	*
color	string	*
agrifield_pria_history_data_narrow	array	*
__field_number_sortable	string	*
rowclass	string	*
responsible_worker	object (Worker)	*	Person responsible for solving issues, faults and problems
partner_ids	array	*
id	integer	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
massive_number	string	*
field_number	string	*
field_size	float	*
water_protection_area_size	float	*
field_usage_description	string	*
location_county	string	*
location_parish	string	*
pria_payee	object (PriaPayee)	*
crop_period	object (CropPeriod)	*
agrifield_data[]	array of objects (AgrifieldData)	*
outer_id	string	*
is_hidden_for_fieldbook	boolean	*
workobject_category	object (WorkobjectCategory)	*
groups[]	array of objects (AgrifieldGroup)	*
location_region	string	*
location_address	string	*
crop	object (Crop)	*
crop_variety	string	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
master_agrifield	object (Agrifield)	*
merged_agrifields[]	array of objects (Agrifield)	*
merged_from_crop_period	object (CropPeriod)	*
is_water_protection_active	boolean	*
geo_item	object (GeoItem)	*
_geom_updated_at_timestamp	integer	*
second_worker	object (Worker)	*	Second responsible person
is_storage	boolean	*
agreement	object (Agreement)	*
agreement_objects[]	array of objects (AgreementObject)	*
inspection_schedule	object (InspectionMasterTemplate)	*	Inspection schedule
fault_severity	integer	*
pria_uuid	string	*
cadastres[]	array of objects (Cadastre)	*
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

GET /api/workobjectsonly

Workobjects without their related agrifield data.

Documentation
Sandbox

Documentation

Returns Only Workobjects collection (for Agricultural Companies)

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 (workobject_list, owner, baseattribute, classificator). 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
responsible_worker	object (Worker)	*	Person responsible for solving issues, faults and problems
id	integer	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
massive_number	string	*
field_number	string	*
outer_id	string	*
workobject_category	object (WorkobjectCategory)	*
location_address	string	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
second_worker	object (Worker)	*	Second responsible person
fault_severity	integer	*
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/workobjectsonly

Creates or modifies a Workobject

Documentation
Sandbox

Documentation

Creates a new Workobject, or modifies the one named in the URL. The workobjectsonly and agrifields routes serve the same entity; a new record with no workobject_category defaults to category 10

Requirements

Name	Requirement	Type	Description
id		integer\|string	Workobject 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.
name	string	true
massive_number	string	false
cadastre_number	string	false
field_number	string	false
location_address	string	false
outer_id	string	false	Identifier in the source system.
location_region	string	false
location_area	object	false	Reference to LocationArea. Send { "id": <id> }, or null to clear.
workobject_category	object	false	Reference to WorkobjectCategory. Send { "id": <id> }, or null to clear.
customer	object	false	Reference to Customer. Send { "id": <id> }, or null to clear.
department	object	false	Reference to Department. Send { "id": <id> }, or null to clear.
responsible_worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
second_worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
inspection_schedule	object	false	Reference to InspectionMasterTemplate. Send { "id": <id> }, or null to clear.
is_archived	boolean	false
is_storage	boolean	false
is_hidden_for_fieldbook	boolean	false
lat	float	false	Latitude of the workobject centroid.
lng	float	false	Longitude of the workobject centroid.
cadastres	array of objects	false	Cadastres to relate to a newly created workobject. Objects with an id field. Read only when the workobject is created.
geo_item	object	false	Geometry of the workobject, as an object with a geojson field holding a geometry. Sending no geo_item removes the existing geometry.
crop_period	integer\|object	false	Crop period to open for the field, as an id such as 2026 or an object with an id field. Read only when at least one of field_size, crop, crop_name or crop_variety is also sent; an unknown or missing value means the current year.
field_size	float	false	Field size in hectares for the crop period. Sending it opens the crop period for the field. Decimal comma is accepted.
crop	object	false	Crop grown in the crop period, as { "id": <id> }. Sending it opens the crop period for the field.
crop_name	string	false	Crop grown in the crop period, by name. Matched against the company's crops and the shared crop list; an unknown name creates a crop. Ignored when crop is sent. Sending it opens the crop period for the field.
crop_variety	string	false	Crop variety for the crop period. Sending it opens the crop period for the field.

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
lat	float	*
lng	float	*
classificator	string	*
color	string	*
agrifield_pria_history_data_narrow	array	*
__field_number_sortable	string	*
rowclass	string	*
responsible_worker	object (Worker)	*	Person responsible for solving issues, faults and problems
partner_ids	array	*
id	integer	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
massive_number	string	*
field_number	string	*
field_size	float	*
water_protection_area_size	float	*
field_usage_description	string	*
location_county	string	*
location_parish	string	*
pria_payee	object (PriaPayee)	*
crop_period	object (CropPeriod)	*
agrifield_data[]	array of objects (AgrifieldData)	*
outer_id	string	*
is_hidden_for_fieldbook	boolean	*
workobject_category	object (WorkobjectCategory)	*
groups[]	array of objects (AgrifieldGroup)	*
location_region	string	*
location_address	string	*
crop	object (Crop)	*
crop_variety	string	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
master_agrifield	object (Agrifield)	*
merged_agrifields[]	array of objects (Agrifield)	*
merged_from_crop_period	object (CropPeriod)	*
is_water_protection_active	boolean	*
geo_item	object (GeoItem)	*
_geom_updated_at_timestamp	integer	*
second_worker	object (Worker)	*	Second responsible person
is_storage	boolean	*
agreement	object (Agreement)	*
agreement_objects[]	array of objects (AgreementObject)	*
inspection_schedule	object (InspectionMasterTemplate)	*	Inspection schedule
fault_severity	integer	*
pria_uuid	string	*
cadastres[]	array of objects (Cadastre)	*
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

DELETE /api/workobjectsonly/{id}

Delete Workobject

Documentation
Sandbox

Documentation

Delete Workobject by ID or UUID

Requirements

Name	Requirement	Type	Description
crop_period_id		integer\|string	CropPeriod id, usually the year (e.g. 2026)
id	\d+	integer	Workobject id

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		Workobject 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	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
crop_period	object (CropPeriod)	*
workobject_category	object (WorkobjectCategory)	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
pria_uuid	string	*
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

GET /api/workobjectsonly/{id}

Get Workobject

Documentation
Sandbox

Documentation

Returns Workobject by ID or UUID

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Workobject id

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		Workobject uuid
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (agrifields, agrifield_all, workobject, geo, owner, sharing, baseattribute, classificator, auditcolumns, fieldbook). 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
lat	float	*
lng	float	*
classificator	string	*
color	string	*
agrifield_pria_history_data_narrow	array	*
__field_number_sortable	string	*
rowclass	string	*
responsible_worker	object (Worker)	*	Person responsible for solving issues, faults and problems
partner_ids	array	*
id	integer	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
massive_number	string	*
field_number	string	*
field_size	float	*
water_protection_area_size	float	*
field_usage_description	string	*
location_county	string	*
location_parish	string	*
pria_payee	object (PriaPayee)	*
crop_period	object (CropPeriod)	*
agrifield_data[]	array of objects (AgrifieldData)	*
outer_id	string	*
is_hidden_for_fieldbook	boolean	*
workobject_category	object (WorkobjectCategory)	*
groups[]	array of objects (AgrifieldGroup)	*
location_region	string	*
location_address	string	*
crop	object (Crop)	*
crop_variety	string	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
master_agrifield	object (Agrifield)	*
merged_agrifields[]	array of objects (Agrifield)	*
merged_from_crop_period	object (CropPeriod)	*
is_water_protection_active	boolean	*
geo_item	object (GeoItem)	*
_geom_updated_at_timestamp	integer	*
second_worker	object (Worker)	*	Second responsible person
is_storage	boolean	*
agreement	object (Agreement)	*
agreement_objects[]	array of objects (AgreementObject)	*
inspection_schedule	object (InspectionMasterTemplate)	*	Inspection schedule
fault_severity	integer	*
pria_uuid	string	*
cadastres[]	array of objects (Cadastre)	*
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/workobjectsonly/{id}

Creates or modifies a Workobject

Documentation
Sandbox

Documentation

Creates a new Workobject, or modifies the one named in the URL. The workobjectsonly and agrifields routes serve the same entity; a new record with no workobject_category defaults to category 10

Requirements

Name	Requirement	Type	Description
id		integer\|string	Workobject 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	true
massive_number	string	false
cadastre_number	string	false
field_number	string	false
location_address	string	false
outer_id	string	false	Identifier in the source system.
location_region	string	false
location_area	object	false	Reference to LocationArea. Send { "id": <id> }, or null to clear.
workobject_category	object	false	Reference to WorkobjectCategory. Send { "id": <id> }, or null to clear.
customer	object	false	Reference to Customer. Send { "id": <id> }, or null to clear.
department	object	false	Reference to Department. Send { "id": <id> }, or null to clear.
responsible_worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
second_worker	object	false	Reference to Worker. Send { "id": <id> }, or null to clear.
inspection_schedule	object	false	Reference to InspectionMasterTemplate. Send { "id": <id> }, or null to clear.
is_archived	boolean	false
is_storage	boolean	false
is_hidden_for_fieldbook	boolean	false
lat	float	false	Latitude of the workobject centroid.
lng	float	false	Longitude of the workobject centroid.
cadastres	array of objects	false	Cadastres to relate to a newly created workobject. Objects with an id field. Read only when the workobject is created.
geo_item	object	false	Geometry of the workobject, as an object with a geojson field holding a geometry. Sending no geo_item removes the existing geometry.
crop_period	integer\|object	false	Crop period to open for the field, as an id such as 2026 or an object with an id field. Read only when at least one of field_size, crop, crop_name or crop_variety is also sent; an unknown or missing value means the current year.
field_size	float	false	Field size in hectares for the crop period. Sending it opens the crop period for the field. Decimal comma is accepted.
crop	object	false	Crop grown in the crop period, as { "id": <id> }. Sending it opens the crop period for the field.
crop_name	string	false	Crop grown in the crop period, by name. Matched against the company's crops and the shared crop list; an unknown name creates a crop. Ignored when crop is sent. Sending it opens the crop period for the field.
crop_variety	string	false	Crop variety for the crop period. Sending it opens the crop period for the field.

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
lat	float	*
lng	float	*
classificator	string	*
color	string	*
agrifield_pria_history_data_narrow	array	*
__field_number_sortable	string	*
rowclass	string	*
responsible_worker	object (Worker)	*	Person responsible for solving issues, faults and problems
partner_ids	array	*
id	integer	*	Workobject id in Terake
name	string	*	Workobject name, Utf8 string 255 chars
fullname	string	*	Workobject fullname, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
massive_number	string	*
field_number	string	*
field_size	float	*
water_protection_area_size	float	*
field_usage_description	string	*
location_county	string	*
location_parish	string	*
pria_payee	object (PriaPayee)	*
crop_period	object (CropPeriod)	*
agrifield_data[]	array of objects (AgrifieldData)	*
outer_id	string	*
is_hidden_for_fieldbook	boolean	*
workobject_category	object (WorkobjectCategory)	*
groups[]	array of objects (AgrifieldGroup)	*
location_region	string	*
location_address	string	*
crop	object (Crop)	*
crop_variety	string	*
customer	object (Customer)	*
location_area	object (LocationArea)	*
master_agrifield	object (Agrifield)	*
merged_agrifields[]	array of objects (Agrifield)	*
merged_from_crop_period	object (CropPeriod)	*
is_water_protection_active	boolean	*
geo_item	object (GeoItem)	*
_geom_updated_at_timestamp	integer	*
second_worker	object (Worker)	*	Second responsible person
is_storage	boolean	*
agreement	object (Agreement)	*
agreement_objects[]	array of objects (AgreementObject)	*
inspection_schedule	object (InspectionMasterTemplate)	*	Inspection schedule
fault_severity	integer	*
pria_uuid	string	*
cadastres[]	array of objects (Cadastre)	*
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

Show/hide List Operations Expand Operations

Worktypes

A Worktype classifies what was done - ploughing, spraying, transport, maintenance. Nearly every record that describes work references one: workdones, plan items, roster items, agrifield works and cost account rules. These endpoints create, edit, archive and delete worktypes and set the hourly rate charged for one. A rate can be set per worker or on the worktype itself. The list is shared with partner companies and archived in two levels.

GET /api/worktypes

All Worktypes list

Documentation
Sandbox

Documentation

Returns Worktype 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 (owner, worktype_all, baseattribute, classificator, 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
is_parent	boolean	*
save_notification_msg	string	*
fullname	string	*
classificator	string	*
id	integer	*	Worktype id in Terake
name	string	*	Worktype name, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
slug	string	*
outer_id	string	*
hourly_rate	float	*
fuel_consumption_per_hour	float	*
is_silage_transport	boolean	*
is_harvesting	boolean	*
is_maintenance	boolean	*
worktype_type_id	integer	*
is_background_work	boolean	*	Watching work
is_faultitem_work	boolean	*	Is Faultitem work
is_hidden_from_mobile	boolean	*	Is hidden from mobile app
exclude_from_fuel_cons	boolean	*
exclude_from_worktime	boolean	*
find_workobject_from_telemetry	boolean	*
archives[]	array of objects (WorktypeArchive)	*
parent_worktype	object (Worktype)	*	User-defined parent worktype If parent_id = self.id then worktype is parent worktype
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/worktypes

Create Worktype

Documentation
Sandbox

Documentation

Creates new Worktype

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.
qr_image	object	false	QR code as { "qr_text": "..." }.
qr	string	false	QR code as plain text. Used only when qr_image is absent.
name	string	true
hourly_rate	float	false	Decimal comma is accepted.
fuel_consumption_per_hour	float	false	Decimal comma is accepted.
is_silage_transport	boolean	false
is_archived	boolean	false
exclude_from_worktime	boolean	false
exclude_from_fuel_cons	boolean	false
is_background_work	boolean	false
is_faultitem_work	boolean	false
is_hidden_from_mobile	boolean	false
is_parent	boolean	false
worktype_type_id	integer	false	WorktypeType id.
find_workobject_from_telemetry	boolean	false
master_worktype	object	false	Reference to Worktype. Send { "id": <id> }, or null to clear.
parent_worktype	object	false	Reference to Worktype. 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
is_parent	boolean	*
save_notification_msg	string	*
fullname	string	*
classificator	string	*
color	string	*
partner_ids	array	*
id	integer	*	Worktype id in Terake
name	string	*	Worktype name, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
slug	string	*
facilities[]	array of objects (Facility)	*
facility_types[]	array of objects (FacilityType)	*
materials[]	array of objects (Material)	*
workobjects[]	array of objects (Agrifield)	*
outer_id	string	*
hourly_rate	float	*
fuel_consumption_per_hour	float	*
is_silage_transport	boolean	*
is_harvesting	boolean	*
is_maintenance	boolean	*
worktype_type_id	integer	*
is_background_work	boolean	*	Watching work
is_faultitem_work	boolean	*	Is Faultitem work
is_hidden_from_mobile	boolean	*	Is hidden from mobile app
exclude_from_fuel_cons	boolean	*
exclude_from_worktime	boolean	*
find_workobject_from_telemetry	boolean	*
archives[]	array of objects (WorktypeArchive)	*
master_worktype	object (Worktype)	*	PRIA Master worktype
parent_worktype	object (Worktype)	*	User-defined parent worktype If parent_id = self.id then worktype is parent worktype
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

DELETE /api/worktypes/{id}

Delete Worktype

Documentation
Sandbox

Documentation

Deletes Worktype by ID or UUID

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Worktype id

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		Worktype 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
is_parent	boolean	*
save_notification_msg	string	*
fullname	string	*
classificator	string	*
color	string	*
id	integer	*	Worktype id in Terake
name	string	*	Worktype name, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
slug	string	*
facilities[]	array of objects (Facility)	*
facility_types[]	array of objects (FacilityType)	*
materials[]	array of objects (Material)	*
workobjects[]	array of objects (Agrifield)	*
outer_id	string	*
hourly_rate	float	*
fuel_consumption_per_hour	float	*
is_silage_transport	boolean	*
is_harvesting	boolean	*
is_maintenance	boolean	*
worktype_type_id	integer	*
is_background_work	boolean	*	Watching work
is_faultitem_work	boolean	*	Is Faultitem work
is_hidden_from_mobile	boolean	*	Is hidden from mobile app
exclude_from_fuel_cons	boolean	*
exclude_from_worktime	boolean	*
find_workobject_from_telemetry	boolean	*
archives[]	array of objects (WorktypeArchive)	*
master_worktype	object (Worktype)	*	PRIA Master worktype
parent_worktype	object (Worktype)	*	User-defined parent worktype If parent_id = self.id then worktype is parent worktype
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

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/worktypes/{id}

Get Worktype

Documentation
Sandbox

Documentation

Returns Worktype by ID or UUID

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Worktype id

Parameters

Parameter	Type	Required?	Format	Description
uuid	string	false		Worktype uuid
groups	string	false		Comma-separated subset of the serializer groups this endpoint offers (sharing, worktype_all, worktype, baseattribute, owner, classificator, 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
is_parent	boolean	*
save_notification_msg	string	*
fullname	string	*
classificator	string	*
color	string	*
partner_ids	array	*
id	integer	*	Worktype id in Terake
name	string	*	Worktype name, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
slug	string	*
facilities[]	array of objects (Facility)	*
facility_types[]	array of objects (FacilityType)	*
materials[]	array of objects (Material)	*
workobjects[]	array of objects (Agrifield)	*
outer_id	string	*
hourly_rate	float	*
fuel_consumption_per_hour	float	*
is_silage_transport	boolean	*
is_harvesting	boolean	*
is_maintenance	boolean	*
worktype_type_id	integer	*
is_background_work	boolean	*	Watching work
is_faultitem_work	boolean	*	Is Faultitem work
is_hidden_from_mobile	boolean	*	Is hidden from mobile app
exclude_from_fuel_cons	boolean	*
exclude_from_worktime	boolean	*
find_workobject_from_telemetry	boolean	*
archives[]	array of objects (WorktypeArchive)	*
master_worktype	object (Worktype)	*	PRIA Master worktype
parent_worktype	object (Worktype)	*	User-defined parent worktype If parent_id = self.id then worktype is parent worktype
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

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/worktypes/{id}

Modify Worktype

Documentation
Sandbox

Documentation

Modify Worktype

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Worktype id

Parameters

Parameter	Type	Required?	Description
id	integer	true	Id of the record being updated. Must match the id in the URL.
qr_image	object	false	QR code as { "qr_text": "..." }.
name	string	false
outer_id	string	false	Identifier in the source system.
hourly_rate	float	false	Decimal comma is accepted.
fuel_consumption_per_hour	float	false	Decimal comma is accepted.
is_silage_transport	boolean	false
is_archived	boolean	false
exclude_from_worktime	boolean	false
exclude_from_fuel_cons	boolean	false
is_background_work	boolean	false
is_faultitem_work	boolean	false
is_hidden_from_mobile	boolean	false
is_parent	boolean	false
worktype_type_id	integer	false	WorktypeType id.
find_workobject_from_telemetry	boolean	false
master_worktype	object	false	Reference to Worktype. Send { "id": <id> }, or null to clear.
parent_worktype	object	false	Reference to Worktype. 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
is_parent	boolean	*
save_notification_msg	string	*
fullname	string	*
classificator	string	*
color	string	*
partner_ids	array	*
id	integer	*	Worktype id in Terake
name	string	*	Worktype name, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
slug	string	*
facilities[]	array of objects (Facility)	*
facility_types[]	array of objects (FacilityType)	*
materials[]	array of objects (Material)	*
workobjects[]	array of objects (Agrifield)	*
outer_id	string	*
hourly_rate	float	*
fuel_consumption_per_hour	float	*
is_silage_transport	boolean	*
is_harvesting	boolean	*
is_maintenance	boolean	*
worktype_type_id	integer	*
is_background_work	boolean	*	Watching work
is_faultitem_work	boolean	*	Is Faultitem work
is_hidden_from_mobile	boolean	*	Is hidden from mobile app
exclude_from_fuel_cons	boolean	*
exclude_from_worktime	boolean	*
find_workobject_from_telemetry	boolean	*
archives[]	array of objects (WorktypeArchive)	*
master_worktype	object (Worktype)	*	PRIA Master worktype
parent_worktype	object (Worktype)	*	User-defined parent worktype If parent_id = self.id then worktype is parent worktype
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

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/worktypes/{id}/savehourlyraterate

Sets the hourly rate of a Worktype

Documentation
Sandbox

Documentation

Sets the hourly rate of a Worktype. With a worker in the body the rate is stored per worker and a zero rate removes it; without one the rate is stored on the Worktype itself. Returns the stored rate row, or the Worktype

Requirements

Name	Requirement	Type	Description
id	\d+	integer	Worktype id

Parameters

Parameter	Type	Required?	Format	Description
worker_id	integer	true		Worker id
hourlyrate	decimal	true		Applied hourly rate

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_parent	boolean	*
save_notification_msg	string	*
fullname	string	*
classificator	string	*
color	string	*
partner_ids	array	*
id	integer	*	Worktype id in Terake
name	string	*	Worktype name, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
slug	string	*
facilities[]	array of objects (Facility)	*
facility_types[]	array of objects (FacilityType)	*
materials[]	array of objects (Material)	*
workobjects[]	array of objects (Agrifield)	*
outer_id	string	*
hourly_rate	float	*
fuel_consumption_per_hour	float	*
is_silage_transport	boolean	*
is_harvesting	boolean	*
is_maintenance	boolean	*
worktype_type_id	integer	*
is_background_work	boolean	*	Watching work
is_faultitem_work	boolean	*	Is Faultitem work
is_hidden_from_mobile	boolean	*	Is hidden from mobile app
exclude_from_fuel_cons	boolean	*
exclude_from_worktime	boolean	*
find_workobject_from_telemetry	boolean	*
archives[]	array of objects (WorktypeArchive)	*
master_worktype	object (Worktype)	*	PRIA Master worktype
parent_worktype	object (Worktype)	*	User-defined parent worktype If parent_id = self.id then worktype is parent worktype
created_at_timestamp	integer	*
updated_at_timestamp	integer	*
is_deleted	boolean	*
is_archived	boolean	*
uuid	string	*
department	object (Department)	*	Department

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/worktypes/{id}/togglearchive

Toggle Archive/Un-archive Worktype

Documentation
Sandbox

Documentation

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

Requirements

Name	Requirement	Type	Description
id		integer\|string	Worktype 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
is_parent	boolean	*
save_notification_msg	string	*
fullname	string	*
classificator	string	*
id	integer	*	Worktype id in Terake
name	string	*	Worktype name, Utf8 string 255 chars
sorting_name	string	*	Worktype name used for sorting, Utf8 string 255 chars
slug	string	*
outer_id	string	*
hourly_rate	float	*
fuel_consumption_per_hour	float	*
is_silage_transport	boolean	*
is_harvesting	boolean	*
is_maintenance	boolean	*
worktype_type_id	integer	*
is_background_work	boolean	*	Watching work
is_faultitem_work	boolean	*	Is Faultitem work
is_hidden_from_mobile	boolean	*	Is hidden from mobile app
exclude_from_fuel_cons	boolean	*
exclude_from_worktime	boolean	*
find_workobject_from_telemetry	boolean	*
archives[]	array of objects (WorktypeArchive)	*
parent_worktype	object (Worktype)	*	User-defined parent worktype If parent_id = self.id then worktype is parent worktype
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

Requirements

= -

Headers

= -

Content

= Replaces header if set

Terake API

Admin

Dates and times

Agreements

POST /api/agreements

Documentation

Parameters

Headers

Return

200

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/agreements/agrifield

Documentation

Parameters

Headers

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/agreements/workobject/{workobject_id}

Documentation

Requirements

Parameters

Headers

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/agreements/{id}

Documentation

Requirements

Headers

Return

200

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/agreements/{id}

Documentation

Requirements

Parameters

Headers

Return

200

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/agreements/{id}

Documentation

Requirements

Parameters

Headers

Return

200

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/agreements/{id}/togglearchive

Documentation