Skip to main content
GET
/
api
/
contact-metrics
/
config
Get category configuration
curl --request GET \
  --url https://your-instance.example.com/api/contact-metrics/config \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "categories": [
      {
        "name": "New",
        "key": "new",
        "statuses": [
          "new"
        ],
        "color": "#3B82F6"
      },
      {
        "name": "Working",
        "key": "working",
        "statuses": [
          "qualified",
          "in-progress"
        ],
        "color": "#10B981"
      }
    ],
    "allowMultipleCategories": false,
    "defaultMetricsPipelineId": "66f0a0b0c0d0e0f0a0b0c0d0",
    "pipelineId": "66f0a0b0c0d0e0f0a0b0c0d0",
    "pipelineName": "Sales pipeline"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pipelineId
string

Response

Metrics config returned

success
enum<boolean>
required
Available options:
true
data
object
required