Task Types

Task types allow you to categorize tasks in your CRM. Each type has a name, icon, and sort order, helping you organize activities like calls, emails, meetings, and follow-ups.

The Task Type Object

Name
id
Type
uuid
Description
Unique identifier for the task type.
Name
workspace_id
Type
uuid
Description
The workspace this task type belongs to.
Name
name
Type
string
Description
Task type name (max 255 characters).
Name
icon
Type
string
Description
Icon identifier for the task type (max 255 characters).
Name
sort
Type
integer
Description
Sort order for displaying task types (starts at 1).
Name
created_at
Type
datetime
Description
Timestamp when the task type was created.
Name
updated_at
Type
datetime
Description
Timestamp when the task type was last updated.

GET/app/task-types

List Task Types

Retrieve all task types in your workspace.

Request

GET

/app/task-types

curl https://api.pipeback.com/app/task-types \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

Response

[
  {
    "id": "9d5f3d04-6f7g-8h9i-0j1k-2l3m4n5o6p7a",
    "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
    "name": "Call",
    "icon": "phone",
    "sort": 1,
    "created_at": "2025-01-15T10:00:00.000000Z",
    "updated_at": "2025-01-15T10:00:00.000000Z"
  },
  {
    "id": "9d5f3d04-6f7g-8h9i-0j1k-2l3m4n5o6p7b",
    "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
    "name": "Email",
    "icon": "mail",
    "sort": 2,
    "created_at": "2025-01-15T10:05:00.000000Z",
    "updated_at": "2025-01-15T10:05:00.000000Z"
  },
  {
    "id": "9d5f3d04-6f7g-8h9i-0j1k-2l3m4n5o6p7c",
    "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
    "name": "Meeting",
    "icon": "calendar",
    "sort": 3,
    "created_at": "2025-01-15T10:10:00.000000Z",
    "updated_at": "2025-01-15T10:10:00.000000Z"
  }
]

POST/app/task-types

Create a Task Type

Create a new task type in your workspace. The task type will be automatically sorted at the end of the current list.

Required Attributes

Name
name
Type
string
Required
*
Description
Task type name (max 255 characters).
Name
icon
Type
string
Required
*
Description
Icon identifier (max 255 characters). This should be a valid icon name from your icon library.

Request

POST

/app/task-types

curl -X POST https://api.pipeback.com/app/task-types \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Demo",
    "icon": "video"
  }'

Response

{
  "id": "9d5f3d04-6f7g-8h9i-0j1k-2l3m4n5o6p7d",
  "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
  "name": "Demo",
  "icon": "video",
  "sort": 4,
  "created_at": "2025-10-26T16:00:00.000000Z",
  "updated_at": "2025-10-26T16:00:00.000000Z"
}

PUT/app/task-types/{id}

Update a Task Type

Update an existing task type's name and icon.

Required Attributes

Name
name
Type
string
Required
*
Description
Task type name (max 255 characters).
Name
icon
Type
string
Required
*
Description
Icon identifier (max 255 characters).

Request

PUT

/app/task-types/{id}

curl -X PUT https://api.pipeback.com/app/task-types/9d5f3d04-6f7g-8h9i-0j1k-2l3m4n5o6p7d \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Product Demo",
    "icon": "presentation"
  }'

Response

{
  "id": "9d5f3d04-6f7g-8h9i-0j1k-2l3m4n5o6p7d",
  "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
  "name": "Product Demo",
  "icon": "presentation",
  "sort": 4,
  "created_at": "2025-10-26T16:00:00.000000Z",
  "updated_at": "2025-10-26T16:15:00.000000Z"
}

DELETE/app/task-types/{id}

Delete a Task Type

Delete a task type from your workspace. This is a hard delete and will permanently remove the task type.

Deleting a task type that is associated with existing tasks may cause data integrity issues. Ensure that tasks using this type are updated or deleted before removing the task type.

Request

DELETE

/app/task-types/{id}

curl -X DELETE https://api.pipeback.com/app/task-types/9d5f3d04-6f7g-8h9i-0j1k-2l3m4n5o6p7d \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

Response

{
}

Common Task Type Icons

Task types typically use icon identifiers that correspond to common activity types:

phone: Phone calls
mail / email: Email communications
calendar: Meetings and appointments
video: Video calls and demos
presentation: Product demonstrations
check: Follow-ups and check-ins
message: Messages and chat
document: Document review or sharing

The specific icon identifiers available depend on your icon library implementation.