Skip to main content
POST
Create goal

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Body

application/json
title
string
required

Goal title (required)

Required string length: 1 - 200
companyId
string<uuid>
required

Company ID (required)

description
string

Goal description

Maximum string length: 5000
statusId
string<uuid>

Status ID

priorityId
string<uuid>

Priority ID

categoryId
string<uuid>

Category ID

dueDate
string<date-time>

Due date (ISO 8601)

progressPercentage
number

Initial progress (0-100)

Required range: 0 <= x <= 100
quarter
string

Quarter (e.g., Q1)

Maximum string length: 2
year
number

Year

Required range: 2000 <= x <= 2100

Response

Goal created successfully

data
object
required