OKRs (or Goals)

The OKRs API provides generic functionality for a broad set of Goal types - including OKRs, Rocks or KPIs. For simplicity, these are referenced as OKRs below. OKRs can be measurable or not and can have any number of children or parents that contribute to its current value. OKRs can be assigned to both Employees and Groups/Teams and by default are allowed to be assigned an owner and support tasks.

List objectives

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

statusstringOptional

Responses

200

OK

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

/api/v1/objective

HTTPcURLJavaScriptPython

GET /api/v1/objective HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2026-01-30T10:52:47.725Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2026-01-30T10:52:47.725Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "description": "text",
    "startDate": "2026-01-30",
    "endDate": "2026-01-30",
    "cycleId": "123e4567-e89b-12d3-a456-426614174000",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
    "measurable": true,
    "metric": {
      "startingValue": 1,
      "currentValue": 1,
      "targetValue": 1,
      "metricType": "text",
      "metricUnit": "text",
      "logs": [
        {
          "value": 1,
          "loggedAt": "2026-01-30T10:52:47.725Z",
          "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
        }
      ]
    },
    "weightTowardsParent": 1,
    "contributesToParent": true,
    "childObjectives": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "organization": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "active": true,
        "status": {
          "current": "text",
          "changedAt": "2026-01-30T10:52:47.725Z",
          "changedBy": "123e4567-e89b-12d3-a456-426614174000"
        },
        "created": {
          "createdAt": "2026-01-30T10:52:47.725Z",
          "createdBy": "123e4567-e89b-12d3-a456-426614174000"
        },
        "description": "text",
        "startDate": "2026-01-30",
        "endDate": "2026-01-30",
        "cycleId": "123e4567-e89b-12d3-a456-426614174000",
        "parentId": "123e4567-e89b-12d3-a456-426614174000",
        "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
        "measurable": true,
        "metric": {
          "startingValue": 1,
          "currentValue": 1,
          "targetValue": 1,
          "metricType": "text",
          "metricUnit": "text",
          "logs": [
            {
              "value": 1,
              "loggedAt": "2026-01-30T10:52:47.725Z",
              "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
            }
          ]
        },
        "weightTowardsParent": 1,
        "contributesToParent": true,
        "childObjectives": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "organization": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "active": true,
            "status": {
              "current": "text",
              "changedAt": "2026-01-30T10:52:47.725Z",
              "changedBy": "123e4567-e89b-12d3-a456-426614174000"
            },
            "created": {
              "createdAt": "2026-01-30T10:52:47.725Z",
              "createdBy": "123e4567-e89b-12d3-a456-426614174000"
            },
            "description": "text",
            "startDate": "2026-01-30",
            "endDate": "2026-01-30",
            "cycleId": "123e4567-e89b-12d3-a456-426614174000",
            "parentId": "123e4567-e89b-12d3-a456-426614174000",
            "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
            "measurable": true,
            "metric": {
              "startingValue": 1,
              "currentValue": 1,
              "targetValue": 1,
              "metricType": "text",
              "metricUnit": "text",
              "logs": [
                {
                  "value": 1,
                  "loggedAt": "2026-01-30T10:52:47.725Z",
                  "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
                }
              ]
            },
            "weightTowardsParent": 1,
            "contributesToParent": true,
            "childObjectives": "[Circular Reference]",
            "assessment": "text",
            "log": [
              {
                "loggedAt": "2026-01-30T10:52:47.725Z",
                "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
                "progress": 1,
                "targetValue": 1,
                "assessment": "text"
              }
            ],
            "assignees": [
              {
                "entityId": "123e4567-e89b-12d3-a456-426614174000",
                "entityType": "text"
              }
            ],
            "mappings": [
              {
                "app": "123e4567-e89b-12d3-a456-426614174000",
                "namespace": "text",
                "mappedId": "text",
                "reference": "text",
                "mappingData": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "mappingSecrets": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                }
              }
            ],
            "tasks": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "text",
                "active": true,
                "status": {
                  "current": "text",
                  "changedAt": "2026-01-30T10:52:47.725Z",
                  "changedBy": "123e4567-e89b-12d3-a456-426614174000"
                },
                "created": {
                  "createdAt": "2026-01-30T10:52:47.725Z",
                  "createdBy": "123e4567-e89b-12d3-a456-426614174000"
                },
                "assignees": [
                  {
                    "entityId": "123e4567-e89b-12d3-a456-426614174000",
                    "entityType": "text"
                  }
                ],
                "organization": "123e4567-e89b-12d3-a456-426614174000",
                "description": "text",
                "dueDate": "2026-01-30",
                "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": "2026-01-30T10:52:47.725Z"
                  }
                ],
                "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"
                    }
                  }
                ]
              }
            ],
            "notes": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "note": "text",
                "author": "123e4567-e89b-12d3-a456-426614174000",
                "createdAt": "2026-01-30T10:52:47.725Z"
              }
            ],
            "sharing": {
              "visibility": "text",
              "ownerId": "123e4567-e89b-12d3-a456-426614174000"
            },
            "order": 1
          }
        ],
        "assessment": "text",
        "log": [
          {
            "loggedAt": "2026-01-30T10:52:47.725Z",
            "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
            "progress": 1,
            "targetValue": 1,
            "assessment": "text"
          }
        ],
        "assignees": [
          {
            "entityId": "123e4567-e89b-12d3-a456-426614174000",
            "entityType": "text"
          }
        ],
        "mappings": [
          {
            "app": "123e4567-e89b-12d3-a456-426614174000",
            "namespace": "text",
            "mappedId": "text",
            "reference": "text",
            "mappingData": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "mappingSecrets": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        ],
        "tasks": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "active": true,
            "status": {
              "current": "text",
              "changedAt": "2026-01-30T10:52:47.725Z",
              "changedBy": "123e4567-e89b-12d3-a456-426614174000"
            },
            "created": {
              "createdAt": "2026-01-30T10:52:47.725Z",
              "createdBy": "123e4567-e89b-12d3-a456-426614174000"
            },
            "assignees": [
              {
                "entityId": "123e4567-e89b-12d3-a456-426614174000",
                "entityType": "text"
              }
            ],
            "organization": "123e4567-e89b-12d3-a456-426614174000",
            "description": "text",
            "dueDate": "2026-01-30",
            "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": "2026-01-30T10:52:47.725Z"
              }
            ],
            "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"
                }
              }
            ]
          }
        ],
        "notes": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "note": "text",
            "author": "123e4567-e89b-12d3-a456-426614174000",
            "createdAt": "2026-01-30T10:52:47.725Z"
          }
        ],
        "sharing": {
          "visibility": "text",
          "ownerId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "order": 1
      }
    ],
    "assessment": "text",
    "log": [
      {
        "loggedAt": "2026-01-30T10:52:47.725Z",
        "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
        "progress": 1,
        "targetValue": 1,
        "assessment": "text"
      }
    ],
    "assignees": [
      {
        "entityId": "123e4567-e89b-12d3-a456-426614174000",
        "entityType": "text"
      }
    ],
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "tasks": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "active": true,
        "status": {
          "current": "text",
          "changedAt": "2026-01-30T10:52:47.725Z",
          "changedBy": "123e4567-e89b-12d3-a456-426614174000"
        },
        "created": {
          "createdAt": "2026-01-30T10:52:47.725Z",
          "createdBy": "123e4567-e89b-12d3-a456-426614174000"
        },
        "assignees": [
          {
            "entityId": "123e4567-e89b-12d3-a456-426614174000",
            "entityType": "text"
          }
        ],
        "organization": "123e4567-e89b-12d3-a456-426614174000",
        "description": "text",
        "dueDate": "2026-01-30",
        "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": "2026-01-30T10:52:47.725Z"
          }
        ],
        "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"
            }
          }
        ]
      }
    ],
    "notes": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "note": "text",
        "author": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2026-01-30T10:52:47.725Z"
      }
    ],
    "sharing": {
      "visibility": "text",
      "ownerId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "order": 1
  }
]

Create objective

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringOptional

descriptionstringOptional

startDatestring · dateOptional

endDatestring · dateOptional

cycleIdstring · uuidOptional

parentIdstring · uuidOptional

startingValuenumberOptional

currentValuenumberOptional

targetValuenumberOptional

metricTypestringOptional

metricUnitstringOptional

weightTowardsParentintegerOptional

assessmentstringOptional

visibilitystringOptional

ownerstring · uuidOptional

orderintegerOptional

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

/api/v1/objective

HTTPcURLJavaScriptPython

POST /api/v1/objective HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 395

{
  "name": "text",
  "description": "text",
  "startDate": "2026-01-30",
  "endDate": "2026-01-30",
  "cycleId": "123e4567-e89b-12d3-a456-426614174000",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "startingValue": 1,
  "currentValue": 1,
  "targetValue": 1,
  "metricType": "text",
  "metricUnit": "text",
  "weightTowardsParent": 1,
  "assessment": "text",
  "visibility": "text",
  "owner": "123e4567-e89b-12d3-a456-426614174000",
  "order": 1
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2026-01-30T10:52:47.725Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2026-01-30T10:52:47.725Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "description": "text",
  "startDate": "2026-01-30",
  "endDate": "2026-01-30",
  "cycleId": "123e4567-e89b-12d3-a456-426614174000",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
  "measurable": true,
  "metric": {
    "startingValue": 1,
    "currentValue": 1,
    "targetValue": 1,
    "metricType": "text",
    "metricUnit": "text",
    "logs": [
      {
        "value": 1,
        "loggedAt": "2026-01-30T10:52:47.725Z",
        "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "weightTowardsParent": 1,
  "contributesToParent": true,
  "childObjectives": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organization": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "active": true,
      "status": {
        "current": "text",
        "changedAt": "2026-01-30T10:52:47.725Z",
        "changedBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created": {
        "createdAt": "2026-01-30T10:52:47.725Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "description": "text",
      "startDate": "2026-01-30",
      "endDate": "2026-01-30",
      "cycleId": "123e4567-e89b-12d3-a456-426614174000",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
      "measurable": true,
      "metric": {
        "startingValue": 1,
        "currentValue": 1,
        "targetValue": 1,
        "metricType": "text",
        "metricUnit": "text",
        "logs": [
          {
            "value": 1,
            "loggedAt": "2026-01-30T10:52:47.725Z",
            "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      },
      "weightTowardsParent": 1,
      "contributesToParent": true,
      "childObjectives": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "organization": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "active": true,
          "status": {
            "current": "text",
            "changedAt": "2026-01-30T10:52:47.725Z",
            "changedBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created": {
            "createdAt": "2026-01-30T10:52:47.725Z",
            "createdBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "description": "text",
          "startDate": "2026-01-30",
          "endDate": "2026-01-30",
          "cycleId": "123e4567-e89b-12d3-a456-426614174000",
          "parentId": "123e4567-e89b-12d3-a456-426614174000",
          "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
          "measurable": true,
          "metric": {
            "startingValue": 1,
            "currentValue": 1,
            "targetValue": 1,
            "metricType": "text",
            "metricUnit": "text",
            "logs": [
              {
                "value": 1,
                "loggedAt": "2026-01-30T10:52:47.725Z",
                "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
              }
            ]
          },
          "weightTowardsParent": 1,
          "contributesToParent": true,
          "childObjectives": [
            "[Circular Reference]"
          ],
          "assessment": "text",
          "log": [
            {
              "loggedAt": "2026-01-30T10:52:47.725Z",
              "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
              "progress": 1,
              "targetValue": 1,
              "assessment": "text"
            }
          ],
          "assignees": [
            {
              "entityId": "123e4567-e89b-12d3-a456-426614174000",
              "entityType": "text"
            }
          ],
          "mappings": [
            {
              "app": "123e4567-e89b-12d3-a456-426614174000",
              "namespace": "text",
              "mappedId": "text",
              "reference": "text",
              "mappingData": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "mappingSecrets": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            }
          ],
          "tasks": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "active": true,
              "status": {
                "current": "text",
                "changedAt": "2026-01-30T10:52:47.725Z",
                "changedBy": "123e4567-e89b-12d3-a456-426614174000"
              },
              "created": {
                "createdAt": "2026-01-30T10:52:47.725Z",
                "createdBy": "123e4567-e89b-12d3-a456-426614174000"
              },
              "assignees": [
                {
                  "entityId": "123e4567-e89b-12d3-a456-426614174000",
                  "entityType": "text"
                }
              ],
              "organization": "123e4567-e89b-12d3-a456-426614174000",
              "description": "text",
              "dueDate": "2026-01-30",
              "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": "2026-01-30T10:52:47.725Z"
                }
              ],
              "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"
                  }
                }
              ]
            }
          ],
          "notes": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "note": "text",
              "author": "123e4567-e89b-12d3-a456-426614174000",
              "createdAt": "2026-01-30T10:52:47.725Z"
            }
          ],
          "sharing": {
            "visibility": "text",
            "ownerId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "order": 1
        }
      ],
      "assessment": "text",
      "log": [
        {
          "loggedAt": "2026-01-30T10:52:47.725Z",
          "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
          "progress": 1,
          "targetValue": 1,
          "assessment": "text"
        }
      ],
      "assignees": [
        {
          "entityId": "123e4567-e89b-12d3-a456-426614174000",
          "entityType": "text"
        }
      ],
      "mappings": [
        {
          "app": "123e4567-e89b-12d3-a456-426614174000",
          "namespace": "text",
          "mappedId": "text",
          "reference": "text",
          "mappingData": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "mappingSecrets": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ],
      "tasks": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "active": true,
          "status": {
            "current": "text",
            "changedAt": "2026-01-30T10:52:47.725Z",
            "changedBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created": {
            "createdAt": "2026-01-30T10:52:47.725Z",
            "createdBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "assignees": [
            {
              "entityId": "123e4567-e89b-12d3-a456-426614174000",
              "entityType": "text"
            }
          ],
          "organization": "123e4567-e89b-12d3-a456-426614174000",
          "description": "text",
          "dueDate": "2026-01-30",
          "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": "2026-01-30T10:52:47.725Z"
            }
          ],
          "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"
              }
            }
          ]
        }
      ],
      "notes": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "note": "text",
          "author": "123e4567-e89b-12d3-a456-426614174000",
          "createdAt": "2026-01-30T10:52:47.725Z"
        }
      ],
      "sharing": {
        "visibility": "text",
        "ownerId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "order": 1
    }
  ],
  "assessment": "text",
  "log": [
    {
      "loggedAt": "2026-01-30T10:52:47.725Z",
      "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
      "progress": 1,
      "targetValue": 1,
      "assessment": "text"
    }
  ],
  "assignees": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "text"
    }
  ],
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "tasks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "active": true,
      "status": {
        "current": "text",
        "changedAt": "2026-01-30T10:52:47.725Z",
        "changedBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created": {
        "createdAt": "2026-01-30T10:52:47.725Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "assignees": [
        {
          "entityId": "123e4567-e89b-12d3-a456-426614174000",
          "entityType": "text"
        }
      ],
      "organization": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text",
      "dueDate": "2026-01-30",
      "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": "2026-01-30T10:52:47.725Z"
        }
      ],
      "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"
          }
        }
      ]
    }
  ],
  "notes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "note": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-30T10:52:47.725Z"
    }
  ],
  "sharing": {
    "visibility": "text",
    "ownerId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "order": 1
}

Get objective

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

OK

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

/api/v1/objective/{id}

HTTPcURLJavaScriptPython

GET /api/v1/objective/{id} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2026-01-30T10:52:47.725Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2026-01-30T10:52:47.725Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "description": "text",
  "startDate": "2026-01-30",
  "endDate": "2026-01-30",
  "cycleId": "123e4567-e89b-12d3-a456-426614174000",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
  "measurable": true,
  "metric": {
    "startingValue": 1,
    "currentValue": 1,
    "targetValue": 1,
    "metricType": "text",
    "metricUnit": "text",
    "logs": [
      {
        "value": 1,
        "loggedAt": "2026-01-30T10:52:47.725Z",
        "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "weightTowardsParent": 1,
  "contributesToParent": true,
  "childObjectives": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organization": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "active": true,
      "status": {
        "current": "text",
        "changedAt": "2026-01-30T10:52:47.725Z",
        "changedBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created": {
        "createdAt": "2026-01-30T10:52:47.725Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "description": "text",
      "startDate": "2026-01-30",
      "endDate": "2026-01-30",
      "cycleId": "123e4567-e89b-12d3-a456-426614174000",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
      "measurable": true,
      "metric": {
        "startingValue": 1,
        "currentValue": 1,
        "targetValue": 1,
        "metricType": "text",
        "metricUnit": "text",
        "logs": [
          {
            "value": 1,
            "loggedAt": "2026-01-30T10:52:47.725Z",
            "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      },
      "weightTowardsParent": 1,
      "contributesToParent": true,
      "childObjectives": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "organization": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "active": true,
          "status": {
            "current": "text",
            "changedAt": "2026-01-30T10:52:47.725Z",
            "changedBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created": {
            "createdAt": "2026-01-30T10:52:47.725Z",
            "createdBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "description": "text",
          "startDate": "2026-01-30",
          "endDate": "2026-01-30",
          "cycleId": "123e4567-e89b-12d3-a456-426614174000",
          "parentId": "123e4567-e89b-12d3-a456-426614174000",
          "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
          "measurable": true,
          "metric": {
            "startingValue": 1,
            "currentValue": 1,
            "targetValue": 1,
            "metricType": "text",
            "metricUnit": "text",
            "logs": [
              {
                "value": 1,
                "loggedAt": "2026-01-30T10:52:47.725Z",
                "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
              }
            ]
          },
          "weightTowardsParent": 1,
          "contributesToParent": true,
          "childObjectives": [
            "[Circular Reference]"
          ],
          "assessment": "text",
          "log": [
            {
              "loggedAt": "2026-01-30T10:52:47.725Z",
              "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
              "progress": 1,
              "targetValue": 1,
              "assessment": "text"
            }
          ],
          "assignees": [
            {
              "entityId": "123e4567-e89b-12d3-a456-426614174000",
              "entityType": "text"
            }
          ],
          "mappings": [
            {
              "app": "123e4567-e89b-12d3-a456-426614174000",
              "namespace": "text",
              "mappedId": "text",
              "reference": "text",
              "mappingData": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "mappingSecrets": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            }
          ],
          "tasks": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "active": true,
              "status": {
                "current": "text",
                "changedAt": "2026-01-30T10:52:47.725Z",
                "changedBy": "123e4567-e89b-12d3-a456-426614174000"
              },
              "created": {
                "createdAt": "2026-01-30T10:52:47.725Z",
                "createdBy": "123e4567-e89b-12d3-a456-426614174000"
              },
              "assignees": [
                {
                  "entityId": "123e4567-e89b-12d3-a456-426614174000",
                  "entityType": "text"
                }
              ],
              "organization": "123e4567-e89b-12d3-a456-426614174000",
              "description": "text",
              "dueDate": "2026-01-30",
              "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": "2026-01-30T10:52:47.725Z"
                }
              ],
              "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"
                  }
                }
              ]
            }
          ],
          "notes": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "note": "text",
              "author": "123e4567-e89b-12d3-a456-426614174000",
              "createdAt": "2026-01-30T10:52:47.725Z"
            }
          ],
          "sharing": {
            "visibility": "text",
            "ownerId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "order": 1
        }
      ],
      "assessment": "text",
      "log": [
        {
          "loggedAt": "2026-01-30T10:52:47.725Z",
          "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
          "progress": 1,
          "targetValue": 1,
          "assessment": "text"
        }
      ],
      "assignees": [
        {
          "entityId": "123e4567-e89b-12d3-a456-426614174000",
          "entityType": "text"
        }
      ],
      "mappings": [
        {
          "app": "123e4567-e89b-12d3-a456-426614174000",
          "namespace": "text",
          "mappedId": "text",
          "reference": "text",
          "mappingData": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "mappingSecrets": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ],
      "tasks": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "active": true,
          "status": {
            "current": "text",
            "changedAt": "2026-01-30T10:52:47.725Z",
            "changedBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created": {
            "createdAt": "2026-01-30T10:52:47.725Z",
            "createdBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "assignees": [
            {
              "entityId": "123e4567-e89b-12d3-a456-426614174000",
              "entityType": "text"
            }
          ],
          "organization": "123e4567-e89b-12d3-a456-426614174000",
          "description": "text",
          "dueDate": "2026-01-30",
          "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": "2026-01-30T10:52:47.725Z"
            }
          ],
          "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"
              }
            }
          ]
        }
      ],
      "notes": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "note": "text",
          "author": "123e4567-e89b-12d3-a456-426614174000",
          "createdAt": "2026-01-30T10:52:47.725Z"
        }
      ],
      "sharing": {
        "visibility": "text",
        "ownerId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "order": 1
    }
  ],
  "assessment": "text",
  "log": [
    {
      "loggedAt": "2026-01-30T10:52:47.725Z",
      "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
      "progress": 1,
      "targetValue": 1,
      "assessment": "text"
    }
  ],
  "assignees": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "text"
    }
  ],
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "tasks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "active": true,
      "status": {
        "current": "text",
        "changedAt": "2026-01-30T10:52:47.725Z",
        "changedBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created": {
        "createdAt": "2026-01-30T10:52:47.725Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "assignees": [
        {
          "entityId": "123e4567-e89b-12d3-a456-426614174000",
          "entityType": "text"
        }
      ],
      "organization": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text",
      "dueDate": "2026-01-30",
      "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": "2026-01-30T10:52:47.725Z"
        }
      ],
      "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"
          }
        }
      ]
    }
  ],
  "notes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "note": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-30T10:52:47.725Z"
    }
  ],
  "sharing": {
    "visibility": "text",
    "ownerId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "order": 1
}

Update objective

patch

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

namestringOptional

descriptionstringOptional

startDatestring · dateOptional

endDatestring · dateOptional

cycleIdstring · uuidOptional

parentIdstring · uuidOptional

startingValuenumberOptional

currentValuenumberOptional

targetValuenumberOptional

metricTypestringOptional

metricUnitstringOptional

weightTowardsParentintegerOptional

assessmentstringOptional

visibilitystringOptional

ownerstring · uuidOptional

orderintegerOptional

Responses

200

OK

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

/api/v1/objective/{id}

HTTPcURLJavaScriptPython

PATCH /api/v1/objective/{id} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 395

{
  "name": "text",
  "description": "text",
  "startDate": "2026-01-30",
  "endDate": "2026-01-30",
  "cycleId": "123e4567-e89b-12d3-a456-426614174000",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "startingValue": 1,
  "currentValue": 1,
  "targetValue": 1,
  "metricType": "text",
  "metricUnit": "text",
  "weightTowardsParent": 1,
  "assessment": "text",
  "visibility": "text",
  "owner": "123e4567-e89b-12d3-a456-426614174000",
  "order": 1
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2026-01-30T10:52:47.725Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2026-01-30T10:52:47.725Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "description": "text",
  "startDate": "2026-01-30",
  "endDate": "2026-01-30",
  "cycleId": "123e4567-e89b-12d3-a456-426614174000",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
  "measurable": true,
  "metric": {
    "startingValue": 1,
    "currentValue": 1,
    "targetValue": 1,
    "metricType": "text",
    "metricUnit": "text",
    "logs": [
      {
        "value": 1,
        "loggedAt": "2026-01-30T10:52:47.725Z",
        "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "weightTowardsParent": 1,
  "contributesToParent": true,
  "childObjectives": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organization": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "active": true,
      "status": {
        "current": "text",
        "changedAt": "2026-01-30T10:52:47.725Z",
        "changedBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created": {
        "createdAt": "2026-01-30T10:52:47.725Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "description": "text",
      "startDate": "2026-01-30",
      "endDate": "2026-01-30",
      "cycleId": "123e4567-e89b-12d3-a456-426614174000",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
      "measurable": true,
      "metric": {
        "startingValue": 1,
        "currentValue": 1,
        "targetValue": 1,
        "metricType": "text",
        "metricUnit": "text",
        "logs": [
          {
            "value": 1,
            "loggedAt": "2026-01-30T10:52:47.725Z",
            "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      },
      "weightTowardsParent": 1,
      "contributesToParent": true,
      "childObjectives": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "organization": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "active": true,
          "status": {
            "current": "text",
            "changedAt": "2026-01-30T10:52:47.725Z",
            "changedBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created": {
            "createdAt": "2026-01-30T10:52:47.725Z",
            "createdBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "description": "text",
          "startDate": "2026-01-30",
          "endDate": "2026-01-30",
          "cycleId": "123e4567-e89b-12d3-a456-426614174000",
          "parentId": "123e4567-e89b-12d3-a456-426614174000",
          "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
          "measurable": true,
          "metric": {
            "startingValue": 1,
            "currentValue": 1,
            "targetValue": 1,
            "metricType": "text",
            "metricUnit": "text",
            "logs": [
              {
                "value": 1,
                "loggedAt": "2026-01-30T10:52:47.725Z",
                "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
              }
            ]
          },
          "weightTowardsParent": 1,
          "contributesToParent": true,
          "childObjectives": [
            "[Circular Reference]"
          ],
          "assessment": "text",
          "log": [
            {
              "loggedAt": "2026-01-30T10:52:47.725Z",
              "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
              "progress": 1,
              "targetValue": 1,
              "assessment": "text"
            }
          ],
          "assignees": [
            {
              "entityId": "123e4567-e89b-12d3-a456-426614174000",
              "entityType": "text"
            }
          ],
          "mappings": [
            {
              "app": "123e4567-e89b-12d3-a456-426614174000",
              "namespace": "text",
              "mappedId": "text",
              "reference": "text",
              "mappingData": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "mappingSecrets": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            }
          ],
          "tasks": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "active": true,
              "status": {
                "current": "text",
                "changedAt": "2026-01-30T10:52:47.725Z",
                "changedBy": "123e4567-e89b-12d3-a456-426614174000"
              },
              "created": {
                "createdAt": "2026-01-30T10:52:47.725Z",
                "createdBy": "123e4567-e89b-12d3-a456-426614174000"
              },
              "assignees": [
                {
                  "entityId": "123e4567-e89b-12d3-a456-426614174000",
                  "entityType": "text"
                }
              ],
              "organization": "123e4567-e89b-12d3-a456-426614174000",
              "description": "text",
              "dueDate": "2026-01-30",
              "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": "2026-01-30T10:52:47.725Z"
                }
              ],
              "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"
                  }
                }
              ]
            }
          ],
          "notes": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "note": "text",
              "author": "123e4567-e89b-12d3-a456-426614174000",
              "createdAt": "2026-01-30T10:52:47.725Z"
            }
          ],
          "sharing": {
            "visibility": "text",
            "ownerId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "order": 1
        }
      ],
      "assessment": "text",
      "log": [
        {
          "loggedAt": "2026-01-30T10:52:47.725Z",
          "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
          "progress": 1,
          "targetValue": 1,
          "assessment": "text"
        }
      ],
      "assignees": [
        {
          "entityId": "123e4567-e89b-12d3-a456-426614174000",
          "entityType": "text"
        }
      ],
      "mappings": [
        {
          "app": "123e4567-e89b-12d3-a456-426614174000",
          "namespace": "text",
          "mappedId": "text",
          "reference": "text",
          "mappingData": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "mappingSecrets": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ],
      "tasks": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "active": true,
          "status": {
            "current": "text",
            "changedAt": "2026-01-30T10:52:47.725Z",
            "changedBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created": {
            "createdAt": "2026-01-30T10:52:47.725Z",
            "createdBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "assignees": [
            {
              "entityId": "123e4567-e89b-12d3-a456-426614174000",
              "entityType": "text"
            }
          ],
          "organization": "123e4567-e89b-12d3-a456-426614174000",
          "description": "text",
          "dueDate": "2026-01-30",
          "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": "2026-01-30T10:52:47.725Z"
            }
          ],
          "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"
              }
            }
          ]
        }
      ],
      "notes": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "note": "text",
          "author": "123e4567-e89b-12d3-a456-426614174000",
          "createdAt": "2026-01-30T10:52:47.725Z"
        }
      ],
      "sharing": {
        "visibility": "text",
        "ownerId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "order": 1
    }
  ],
  "assessment": "text",
  "log": [
    {
      "loggedAt": "2026-01-30T10:52:47.725Z",
      "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
      "progress": 1,
      "targetValue": 1,
      "assessment": "text"
    }
  ],
  "assignees": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "text"
    }
  ],
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "tasks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "active": true,
      "status": {
        "current": "text",
        "changedAt": "2026-01-30T10:52:47.725Z",
        "changedBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created": {
        "createdAt": "2026-01-30T10:52:47.725Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "assignees": [
        {
          "entityId": "123e4567-e89b-12d3-a456-426614174000",
          "entityType": "text"
        }
      ],
      "organization": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text",
      "dueDate": "2026-01-30",
      "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": "2026-01-30T10:52:47.725Z"
        }
      ],
      "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"
          }
        }
      ]
    }
  ],
  "notes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "note": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-30T10:52:47.725Z"
    }
  ],
  "sharing": {
    "visibility": "text",
    "ownerId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "order": 1
}

Log objective progress

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

typestringRequired

valuenumberRequired

requestorstring · uuidOptional

Responses

200

OK

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

/api/v1/objective/{id}/progress

HTTPcURLJavaScriptPython

POST /api/v1/objective/{id}/progress HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "type": "text",
  "value": 1,
  "requestor": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2026-01-30T10:52:47.725Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2026-01-30T10:52:47.725Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "description": "text",
  "startDate": "2026-01-30",
  "endDate": "2026-01-30",
  "cycleId": "123e4567-e89b-12d3-a456-426614174000",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
  "measurable": true,
  "metric": {
    "startingValue": 1,
    "currentValue": 1,
    "targetValue": 1,
    "metricType": "text",
    "metricUnit": "text",
    "logs": [
      {
        "value": 1,
        "loggedAt": "2026-01-30T10:52:47.725Z",
        "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  },
  "weightTowardsParent": 1,
  "contributesToParent": true,
  "childObjectives": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organization": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "active": true,
      "status": {
        "current": "text",
        "changedAt": "2026-01-30T10:52:47.725Z",
        "changedBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created": {
        "createdAt": "2026-01-30T10:52:47.725Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "description": "text",
      "startDate": "2026-01-30",
      "endDate": "2026-01-30",
      "cycleId": "123e4567-e89b-12d3-a456-426614174000",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
      "measurable": true,
      "metric": {
        "startingValue": 1,
        "currentValue": 1,
        "targetValue": 1,
        "metricType": "text",
        "metricUnit": "text",
        "logs": [
          {
            "value": 1,
            "loggedAt": "2026-01-30T10:52:47.725Z",
            "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      },
      "weightTowardsParent": 1,
      "contributesToParent": true,
      "childObjectives": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "organization": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "active": true,
          "status": {
            "current": "text",
            "changedAt": "2026-01-30T10:52:47.725Z",
            "changedBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created": {
            "createdAt": "2026-01-30T10:52:47.725Z",
            "createdBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "description": "text",
          "startDate": "2026-01-30",
          "endDate": "2026-01-30",
          "cycleId": "123e4567-e89b-12d3-a456-426614174000",
          "parentId": "123e4567-e89b-12d3-a456-426614174000",
          "treeRootId": "123e4567-e89b-12d3-a456-426614174000",
          "measurable": true,
          "metric": {
            "startingValue": 1,
            "currentValue": 1,
            "targetValue": 1,
            "metricType": "text",
            "metricUnit": "text",
            "logs": [
              {
                "value": 1,
                "loggedAt": "2026-01-30T10:52:47.725Z",
                "loggedBy": "123e4567-e89b-12d3-a456-426614174000"
              }
            ]
          },
          "weightTowardsParent": 1,
          "contributesToParent": true,
          "childObjectives": [
            "[Circular Reference]"
          ],
          "assessment": "text",
          "log": [
            {
              "loggedAt": "2026-01-30T10:52:47.725Z",
              "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
              "progress": 1,
              "targetValue": 1,
              "assessment": "text"
            }
          ],
          "assignees": [
            {
              "entityId": "123e4567-e89b-12d3-a456-426614174000",
              "entityType": "text"
            }
          ],
          "mappings": [
            {
              "app": "123e4567-e89b-12d3-a456-426614174000",
              "namespace": "text",
              "mappedId": "text",
              "reference": "text",
              "mappingData": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "mappingSecrets": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            }
          ],
          "tasks": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "active": true,
              "status": {
                "current": "text",
                "changedAt": "2026-01-30T10:52:47.725Z",
                "changedBy": "123e4567-e89b-12d3-a456-426614174000"
              },
              "created": {
                "createdAt": "2026-01-30T10:52:47.725Z",
                "createdBy": "123e4567-e89b-12d3-a456-426614174000"
              },
              "assignees": [
                {
                  "entityId": "123e4567-e89b-12d3-a456-426614174000",
                  "entityType": "text"
                }
              ],
              "organization": "123e4567-e89b-12d3-a456-426614174000",
              "description": "text",
              "dueDate": "2026-01-30",
              "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": "2026-01-30T10:52:47.725Z"
                }
              ],
              "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"
                  }
                }
              ]
            }
          ],
          "notes": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "note": "text",
              "author": "123e4567-e89b-12d3-a456-426614174000",
              "createdAt": "2026-01-30T10:52:47.725Z"
            }
          ],
          "sharing": {
            "visibility": "text",
            "ownerId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "order": 1
        }
      ],
      "assessment": "text",
      "log": [
        {
          "loggedAt": "2026-01-30T10:52:47.725Z",
          "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
          "progress": 1,
          "targetValue": 1,
          "assessment": "text"
        }
      ],
      "assignees": [
        {
          "entityId": "123e4567-e89b-12d3-a456-426614174000",
          "entityType": "text"
        }
      ],
      "mappings": [
        {
          "app": "123e4567-e89b-12d3-a456-426614174000",
          "namespace": "text",
          "mappedId": "text",
          "reference": "text",
          "mappingData": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "mappingSecrets": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ],
      "tasks": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "active": true,
          "status": {
            "current": "text",
            "changedAt": "2026-01-30T10:52:47.725Z",
            "changedBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "created": {
            "createdAt": "2026-01-30T10:52:47.725Z",
            "createdBy": "123e4567-e89b-12d3-a456-426614174000"
          },
          "assignees": [
            {
              "entityId": "123e4567-e89b-12d3-a456-426614174000",
              "entityType": "text"
            }
          ],
          "organization": "123e4567-e89b-12d3-a456-426614174000",
          "description": "text",
          "dueDate": "2026-01-30",
          "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": "2026-01-30T10:52:47.725Z"
            }
          ],
          "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"
              }
            }
          ]
        }
      ],
      "notes": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "note": "text",
          "author": "123e4567-e89b-12d3-a456-426614174000",
          "createdAt": "2026-01-30T10:52:47.725Z"
        }
      ],
      "sharing": {
        "visibility": "text",
        "ownerId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "order": 1
    }
  ],
  "assessment": "text",
  "log": [
    {
      "loggedAt": "2026-01-30T10:52:47.725Z",
      "loggedBy": "123e4567-e89b-12d3-a456-426614174000",
      "progress": 1,
      "targetValue": 1,
      "assessment": "text"
    }
  ],
  "assignees": [
    {
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "text"
    }
  ],
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "tasks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "active": true,
      "status": {
        "current": "text",
        "changedAt": "2026-01-30T10:52:47.725Z",
        "changedBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "created": {
        "createdAt": "2026-01-30T10:52:47.725Z",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000"
      },
      "assignees": [
        {
          "entityId": "123e4567-e89b-12d3-a456-426614174000",
          "entityType": "text"
        }
      ],
      "organization": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text",
      "dueDate": "2026-01-30",
      "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": "2026-01-30T10:52:47.725Z"
        }
      ],
      "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"
          }
        }
      ]
    }
  ],
  "notes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "note": "text",
      "author": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-01-30T10:52:47.725Z"
    }
  ],
  "sharing": {
    "visibility": "text",
    "ownerId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "order": 1
}

List objective cycles

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

statusstringOptional

Responses

200

OK

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

/api/v1/objective-cycle

HTTPcURLJavaScriptPython

GET /api/v1/objective-cycle HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "active": true,
    "status": {
      "current": "text",
      "changedAt": "2026-01-30T10:52:47.725Z",
      "changedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "created": {
      "createdAt": "2026-01-30T10:52:47.725Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "startDate": "2026-01-30",
    "endDate": "2026-01-30",
    "description": "text",
    "mappings": [
      {
        "app": "123e4567-e89b-12d3-a456-426614174000",
        "namespace": "text",
        "mappedId": "text",
        "reference": "text",
        "mappingData": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "mappingSecrets": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ]
  }
]

Create objective cycle

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

descriptionstringOptional

startDatestring · dateRequired

endDatestring · dateRequired

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

/api/v1/objective-cycle

HTTPcURLJavaScriptPython

POST /api/v1/objective-cycle HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "name": "text",
  "description": "text",
  "startDate": "2026-01-30",
  "endDate": "2026-01-30"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2026-01-30T10:52:47.725Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2026-01-30T10:52:47.725Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "startDate": "2026-01-30",
  "endDate": "2026-01-30",
  "description": "text",
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Get objective cycle

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

OK

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

/api/v1/objective-cycle/{id}

HTTPcURLJavaScriptPython

GET /api/v1/objective-cycle/{id} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2026-01-30T10:52:47.725Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2026-01-30T10:52:47.725Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "startDate": "2026-01-30",
  "endDate": "2026-01-30",
  "description": "text",
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Update objective cycle

patch

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

namestringRequired

descriptionstringOptional

startDatestring · dateRequired

endDatestring · dateRequired

Responses

200

OK

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

/api/v1/objective-cycle/{id}

HTTPcURLJavaScriptPython

PATCH /api/v1/objective-cycle/{id} HTTP/1.1
Host: api.peoplelogic.dev
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "name": "text",
  "description": "text",
  "startDate": "2026-01-30",
  "endDate": "2026-01-30"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "active": true,
  "status": {
    "current": "text",
    "changedAt": "2026-01-30T10:52:47.725Z",
    "changedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "created": {
    "createdAt": "2026-01-30T10:52:47.725Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "startDate": "2026-01-30",
  "endDate": "2026-01-30",
  "description": "text",
  "mappings": [
    {
      "app": "123e4567-e89b-12d3-a456-426614174000",
      "namespace": "text",
      "mappedId": "text",
      "reference": "text",
      "mappingData": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "mappingSecrets": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}