List Tasks

List tasks

curl --request GET \
  --url http://localhost:3000/v2/tasks/ \
  --header 'x-API-Key: <api-key>'

[
  {
    "status": {
      "status": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedAt": "2023-11-07T05:31:56Z",
      "lastModifiedBy": "<string>"
    },
    "title": "<string>",
    "identifierNumber": 123,
    "_id": "<string>",
    "number": 123,
    "companyId": "<string>",
    "chatId": "<string>",
    "taskStatus": "new",
    "taskType": "<unknown>",
    "taskTypeId": "<string>",
    "taskTemplate": {
      "entityId": "<string>",
      "templateName": "<string>",
      "recurring": true
    },
    "description": "<string>",
    "contactPerson": "<string>",
    "email": "<string>",
    "telephone": "<string>",
    "assignee": {
      "name": "<string>",
      "entityId": "<string>",
      "profilePicture": "https://example.com/profiles/user123.jpg"
    },
    "dueDate": "<unknown>",
    "firstStartedAt": "<unknown>",
    "firstTerminatedAt": "<unknown>",
    "complaintCreatedAt": "<unknown>",
    "tags": [
      "<string>"
    ],
    "priority": "<string>",
    "related": {},
    "documentIds": [
      "<string>"
    ],
    "callId": "<string>",
    "completionResponse": "<string>"
  }
]

GET

tasks

List tasks

curl --request GET \
  --url http://localhost:3000/v2/tasks/ \
  --header 'x-API-Key: <api-key>'

[
  {
    "status": {
      "status": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedAt": "2023-11-07T05:31:56Z",
      "lastModifiedBy": "<string>"
    },
    "title": "<string>",
    "identifierNumber": 123,
    "_id": "<string>",
    "number": 123,
    "companyId": "<string>",
    "chatId": "<string>",
    "taskStatus": "new",
    "taskType": "<unknown>",
    "taskTypeId": "<string>",
    "taskTemplate": {
      "entityId": "<string>",
      "templateName": "<string>",
      "recurring": true
    },
    "description": "<string>",
    "contactPerson": "<string>",
    "email": "<string>",
    "telephone": "<string>",
    "assignee": {
      "name": "<string>",
      "entityId": "<string>",
      "profilePicture": "https://example.com/profiles/user123.jpg"
    },
    "dueDate": "<unknown>",
    "firstStartedAt": "<unknown>",
    "firstTerminatedAt": "<unknown>",
    "complaintCreatedAt": "<unknown>",
    "tags": [
      "<string>"
    ],
    "priority": "<string>",
    "related": {},
    "documentIds": [
      "<string>"
    ],
    "callId": "<string>",
    "completionResponse": "<string>"
  }
]

Authorizations

x-API-Key

string

header

required

Query Parameters

limit

integer

default:100

Maximum number of items to return

Required range: 1 <= x <= 1000

offset

integer

default:0

Number of items to skip for pagination

Required range: x >= 0

sort

string

Sort field and direction (e.g. status.createdAt:-1, dueDate:1)

customer

string<objectid>[]

Filter by customer IDs

userIds

string<objectId>[]

Filter to search jobs by user IDs. If the user ID is "unassigned_jobs", it will search for jobs without a user ID.

User ID to filter jobs by. If "unassigned_jobs" is included, it will also search for jobs without a user ID.

taskByTitleIdentifier

string

Filter by task title or identifier

taskAssignee

string<objectId>[]

Filter to search tasks by assignee ID.

Assignee ID to filter tasks by.

Filter by related contacts

Filter by related users

Filter by related objects

Filter by related customers

Filter by related assignments

Filter by related invoices

Filter by related equipments

taskStatus

string

Filter by status (single value or comma-separated list)

priority

string[]

Filter by priority (single value or comma-separated list)

callId

string[]

Filter by call ID (single value or comma-separated list)

taskTabs

string[]

Filter by task tabs

taskType

string<objectid>[]

Filter by task type

taskFromRecurringTemplate

string

Filter tasks created from recurring templates (true/false)

status

string

Filter by status (single value or comma-separated list)

Response

List of tasks

status

object

required

Entity Status information

Show child attributes

title

string | null

required

Title of the task

identifierNumber

integer | null

required

Task identifier number (task number for each task type)

_id

string<objectid>

Unique identifier of the entity

number

integer

Unique number of the entity, used for identification

companyId

string<objectid>

The ID of the company this entity belongs to

chatId

string<objectid> | null

ID of the chat associated with this entity

taskStatus

enum<string> | null

Status of the task

Available options:

new,

open,

in_progress,

in_review,

completed,

cancelled

taskType

any | null

Type of the task

taskTypeId

string<objectid> | null

Task type ID

taskTemplate

Task Template DTO · object

Task template reference

Show child attributes

description

string | null

Description of the task

contactPerson

string | null

Contact person of the task

string | null

Email of the task

telephone

string | null

Telephone of the task

assignee

RelatedEntity · object

An entity related to a task (user, object, customer, etc.)

Show child attributes

dueDate

any | null

Due date

firstStartedAt

any | null

time stamp when the task was first moved away from "new" status

firstTerminatedAt

any | null

time stamp when the task was first moved to "completed" status

complaintCreatedAt

any | null

time stamp when the complaint that is the source of this task was created (to keep reaction times)

Getting Started

Users

Salaries

Jobs

Time Tracking

Objects

Customers

Equipment

Articles

Tasks

Task Types

Tickets

Absences

Material Orders

Quality Control

Documents

Logbuch

Webhooks

Authorizations

Query Parameters

Response