Skip to content

Get task by ID

Request

Retrieve a single task for the location.

Security
PartnerApiKey and PartnerOAuth
Path
taskIdinteger, (int64)required

Task ID

Example:42
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/task/42' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Task found

Bodyapplication/json
actionstring

Task action

Example:"VIEW_LABS"
assigneeStaffIdsArray of integers

Staff IDs the task is assigned to

Example:
[
  987,
  654
]
commentstring

Free-text comment

Example:"Follow up on elevated values"
createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
createdByStaffIdinteger, (int64)

Staff ID who created the task; null for system-generated tasks

Example:987
dueDatestring

Due date (YYYY-MM-DD, location timezone)

Example:"2025-01-15"
idinteger, (int64)

Task ID

Example:42
locationIdinteger, (int64)

Location ID

Example:1312
overdueboolean

Whether the task is past due (open + dueDate before today in the location's timezone)

Example:false
relatedToArray of objects(TaskRelationDTO)

Entities this task relates to

statusstring

Status

Enum:"OPEN""COMPLETED""DELETED"
Example:"OPEN"
systemboolean

Whether the task was system-generated (vs manually created)

Example:false
titlestring

Title

Example:"Review lab results"
typestring

Task type

Example:"LABS"
updatedAtstring, (date-time)

Last update timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
Response
{
  "action": "VIEW_LABS",
  "assigneeStaffIds": [
    987,
    654
  ],
  "comment": "Follow up on elevated values",
  "createdAt": "2025-01-15T14:00:00Z",
  "createdByStaffId": 987,
  "dueDate": "2025-01-15",
  "id": 42,
  "locationId": 1312,
  "overdue": false,
  "relatedTo": [
    { … }
  ],
  "status": "OPEN",
  "system": false,
  "title": "Review lab results",
  "type": "LABS",
  "updatedAt": "2025-01-15T14:00:00Z"
}