Skip to main content
POST
/
api
/
tasks
/
{id}
/
enter
Enter a task (HHD)
curl --request POST \
  --url https://clarus-api.com/api/tasks/{id}/enter \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Clarus-Subdomain: <api-key>'
{
  "error": "<string>"
}

​
Behavior

This endpoint is used by handheld devices (HHDs) to claim and enter tasks.

​
State Transitions

Current StateAction
AVAILABLEAllocates task to current user, sets assigned_at and start_at
ALLOCATED (to current user)Updates last_accessed_at timestamp
ALLOCATED (to different user)Returns 422 error
COMPLETEDReturns 422 error
  • Returns 204 No Content on success
  • No request body required

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

​
id
integer
required

The unique identifier of the task to enter

Response

Operation completed successfully with no content to return