This page describes API endpoints for viewing, editing, and creating Goal Types.

View Goal Types

GET /backend/open-api/v1/users/goal_types/{goal_type_id}

View all existing Goal Types.

Headers

Name Value
Authorization Bearer <token>

Path parameters

Name Type Description Required
goal_type_id Integer ID of a Goal Type. Add to the path to review a single goal Type.

Response

{
    "data": [
        {
            "id": 1,
            "name": "Lead",
            "privacy": false,
            "created_at": "2021-06-25 14:01:22"
        },
        
       ...
        
        {
            "id": 158,
            "name": "test Goal Type",
            "privacy": false,
            "created_at": "2024-04-21 08:14:33"
        }
    ],
    "total": 22,
    "per_page": 200,
    "page": 1,
    "pages": 1
}

Create a new Goal Type

POST /backend/open-api/v1/users/goal_types/

Create a Goal Type.

Headers

Name Value
Content-Type application/json
Authorization Bearer <token>