Gipo
Resources

Client task types

The task types the Client portal shows, and their links to internal task types.

Client task types are the types a client reads in the Client portal (e.g. Problem, Improvement). The portal never shows an internal task type. It shows the client type that the task's internal type links to, or no type.

  • Each internal task type links to at most one client type. Many internal types can link to the same client type.
  • defaultTaskTypeId is the internal type that a client request of this type gets. It is always one of the linked types.
  • Unlinking an internal type, or linking it to another client type, clears it as the default of the client type it leaves.
  • Deleting a client type unlinks its internal types. Deleting an internal type clears it as a default.

Reads need any API key of the organization. Writes need a key of an owner or admin.

Endpoints

MethodPathNotes
GET/api/v1/client-task-typesList client types alphabetical by name. Offset pagination.
POST/api/v1/client-task-typesCreate a client type. Supports Idempotency-Key.
GET/api/v1/client-task-types/{id}Get one client type.
PATCH/api/v1/client-task-types/{id}Update the name, color, links or default.
DELETE/api/v1/client-task-types/{id}Delete a client type.

ClientTaskType model

{
  "id": "ct1…",
  "organizationId": "...",
  "name": "Problem",
  "color": "#ef4444",
  "defaultTaskTypeId": "tt1…",
  "taskTypes": [{ "id": "tt1…", "name": "Bug", "color": "#f97316" }],
  "createdAt": "...",
  "updatedAt": "..."
}

Creating a client type

POST /api/v1/client-task-types
{ "name": "Problem", "color": "#ef4444" }

The name is unique per organization: a taken name returns 409.

Linking internal types

PATCH /api/v1/client-task-types/ct1…
{ "taskTypeIds": ["tt1…", "tt2…"], "defaultTaskTypeId": "tt1…" }

taskTypeIds replaces the full set of linked internal types. A type that links to another client type moves here. A defaultTaskTypeId outside the linked types returns 400.

On this page