Skip to main content
GET
/
api
/
public
/
v1
/
goals
List goals
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/goals \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "description": "<string>",
      "dueDate": "2023-11-07T05:31:56Z",
      "progressPercentage": 50,
      "quarter": "<string>",
      "year": 123,
      "company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "status": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "priority": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "category": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "totalCount": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
number
default:1

Page number

Required range: x >= 1
​
limit
number
default:25

Items per page

Required range: 1 <= x <= 100
​
sortColumn
enum<string>
default:created_at

Field to sort by

Available options:
title,
due_date,
progress_percentage,
created_at,
updated_at
​
sortDesc
boolean | null
default:true

Sort descending

​
search
string

Search in title and description

Maximum string length: 255
​
companyId
string<uuid>

Filter by company ID

​
statusId
string<uuid>

Filter by status ID

​
priorityId
string<uuid>

Filter by priority ID

​
categoryId
string<uuid>

Filter by category ID

​
dueDatePreset
enum<string>

Filter by due date preset

Available options:
today,
past-due,
next-week,
this-month,
not-set

Response

List of goals

​
data
object[]
required

Array of goals

​
pagination
object
required