Tasks (or Assignments)

Tasks can be associated with nearly all Entity objects in the platform, but appear most often on OKRs, Meetings and IDPs.

Create task for entity

post

Authorizations

Path parameters

entitystringRequired

Body

namestringRequired

descriptionstringOptional

dueDatestring · dateOptional

orderintegerOptional

orderGroupstring · uuidOptional

Responses

201

Created

application/json

400

Bad Request – invalid request payload.

401

Unauthorized – missing or invalid JWT.

403

Forbidden – insufficient permissions.

404

Not Found – no Entity with that ID.

post

POST /api/v1/entity/{entity}/task HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "name": "text",
  "description": "text",
  "dueDate": "2025-07-17",
  "order": 1,
  "orderGroup": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-17T11:47:10.886Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-17T11:47:10.886Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "assignees": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "text"
    }
  ],
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "description": "text",
  "dueDate": "2025-07-17",
  "connectedTo": {
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "organization": "123e4567-e89b-12d3-a456-426614174000"
  },
  "notes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "note": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-07-17T11:47:10.886Z"
    }
  ],
  "order": 1,
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Update task for entity

patch

Authorizations

Path parameters

entitystringRequired

taskstringRequired

Body

namestringRequired

descriptionstringOptional

dueDatestring · dateOptional

orderintegerOptional

orderGroupstring · uuidOptional

Responses

200

application/json

400

Bad Request – invalid request payload.

401

Unauthorized – missing or invalid JWT.

403

Forbidden – insufficient permissions.

404

Not Found – no Entity with that ID.

patch

PATCH /api/v1/entity/{entity}/task/{task} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "name": "text",
  "description": "text",
  "dueDate": "2025-07-17",
  "order": 1,
  "orderGroup": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-17T11:47:10.886Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-17T11:47:10.886Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "assignees": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "text"
    }
  ],
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "description": "text",
  "dueDate": "2025-07-17",
  "connectedTo": {
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "organization": "123e4567-e89b-12d3-a456-426614174000"
  },
  "notes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "note": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-07-17T11:47:10.886Z"
    }
  ],
  "order": 1,
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Get task

get

Authorizations

Path parameters

taskstringRequired

Responses

200

application/json

400

Bad Request – invalid request payload.

401

Unauthorized – missing or invalid JWT.

403

Forbidden – insufficient permissions.

404

Not Found – no Entity with that ID.

get

GET /api/v1/task/{task} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer JWT
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2025-07-17T11:47:10.886Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2025-07-17T11:47:10.886Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "assignees": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "text"
    }
  ],
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "description": "text",
  "dueDate": "2025-07-17",
  "connectedTo": {
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "organization": "123e4567-e89b-12d3-a456-426614174000"
  },
  "notes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "note": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-07-17T11:47:10.886Z"
    }
  ],
  "order": 1,
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

PreviousApps NextAgent API

Was this helpful?