CRM options

List pipeline stages, lead sources and every fixed CRM choice.

Returns the pipeline stages (statuses) and lead sources belonging to the member identified by x-auth-user, plus the fixed option sets used across the CRM: visibility, lead statuses, activity kinds, priorities, availabilities, durations, task categories, custom field types, built-in lead sources and label/stage colors. Use these values when calling create-contact or create-lead.

Query parameters

This endpoint takes no parameters.

Responses

200OKMember pipelines and lead sources plus the fixed CRM option sets.

{
  "success": true,
  "pipelines": [
    { "id": "...", "name": "Lead In", "color": "#3b82f6", "probability": 10, "sort_order": 0, "is_won": false, "is_lost": false, "is_lead_in": true }
  ],
  "lead_sources": [
    { "id": "...", "name": "Contact Me Form", "sort_order": 0 }
  ],
  "visibility": ["Only Me", "My Enroller", "Company Owner / Team Leader", "My Enrolled Team", "Entire Company Team"],
  "visibility_rules": { "exclusive": "Only Me" },
  "lead_statuses": ["open", "won", "lost"],
  "activity_kinds": [{ "value": "call", "label": "Call" }],
  "activity_priorities": ["low", "medium", "high"],
  "activity_availabilities": ["busy", "free"],
  "activity_durations": [15, 30, 45, 60],
  "task_categories": ["Follow up", "Proposal"],
  "lead_field_types": [{ "value": "dropdown", "label": "Dropdown", "has_options": true }],
  "built_in_lead_sources": ["Contact Me Form", "Referral"],
  "label_colors": ["#3b82f6"],
  "stage_colors": ["#3b82f6"]
}

401UnauthorizedMissing or invalid x-auth-token, or missing x-auth-user.

{ "success": false, "error": "Missing x-auth-user header" }

404Not foundNo active member in your company matches x-auth-user.

{ "success": false, "error": "No member matches "jane-doe" in this company." }

GET/api/public/v1/crm-options

x-auth-token

Kept in this tab only — never stored, and never written into the copied code samples.

ResponseNot sent yet