🎯 Leads

Sales lead tracking and management

List leads

get

/api/v1.0/organisation/{org_uid}/leads/

Get a paginated list of leads with optional filters

Authorizations

sessionidstringRequired

Path parameters

org_uidstringRequired

Query parameters

namestringOptional

Filter leads by name/title (case-insensitive partial match)

sourcestringOptional

Filter by lead source

statusstring · enumOptional

Filter leads by status: won (probability=100), lost (probability=0), or open (not won/lost)

Possible values:

Responses

200Success

application/json

Comprehensive serializer for Lead model. Handles multilingual fields, sales stage relationships, and computed metrics like weighted value.

unique_idstring · max: 100 · nullableOptional

titlestringRequired

descriptionstring · nullableOptional

qualification_notesstring · nullableOptional

prioritystring · enumOptional

• low - Low
• medium - Medium
• high - High
• critical - Critical

Possible values:

lead_sourcestring · enumRequired

Select one of the predefined lead sources.

• website - Website
• social_media - Social Media
• email_marketing - Email Marketing
• referral - Referral
• cold_calling - Cold Calling
• trade_show - Trade Show
• advertising - Advertising
• content_marketing - Content Marketing
• seo - SEO
• ppc - Pay-per-Click
• partner - Partner
• other - Other

Possible values:

estimated_valuestring · decimal · nullableOptionalPattern: ^-?\d{0,16}(?:\.\d{0,2})?$

win_probabilitystring · decimal · nullableOptionalPattern: ^-?\d{0,3}(?:\.\d{0,2})?$

weighted_valuestring · decimal · nullableRead-onlyRequiredPattern: ^-?\d{0,16}(?:\.\d{0,2})?$

sales_stagestring · nullableRequired

Unique ID of an existing sales stage.

clientstring · nullableOptional

Unique ID of an existing client.

expected_close_datestring · date · nullableOptional

follow_up_datestring · date-time · nullableOptional

is_closedbooleanRead-onlyRequired

date_createdstring · date-timeRead-onlyRequired

last_updatedstring · date-timeRead-onlyRequired

401

Unauthorized

403

Forbidden

get/api/v1.0/organisation/{org_uid}/leads/

GET /api/v1.0/organisation/{org_uid}/leads/ HTTP/1.1
Host: skhokho.ai
Accept: */*

[
  {
    "unique_id": "text",
    "title": "text",
    "description": "text",
    "qualification_notes": "text",
    "priority": "low",
    "lead_source": "website",
    "estimated_value": "text",
    "win_probability": "text",
    "weighted_value": "text",
    "sales_stage": "text",
    "client": "text",
    "expected_close_date": "2026-01-01",
    "follow_up_date": "2026-01-01T00:00:00.000Z",
    "created_by": {
      "unique_id": "text",
      "full_name": "text"
    },
    "assigned_to": {
      "unique_id": "text",
      "full_name": "text"
    },
    "is_closed": true,
    "date_created": "2026-01-01T00:00:00.000Z",
    "last_updated": "2026-01-01T00:00:00.000Z"
  }
]

Create lead

post

/api/v1.0/organisation/{org_uid}/leads/create/

Create a new lead. Lead title, sales stage, and lead source are required.

Authorizations

sessionidstringRequired

Path parameters

org_uidstringRequired

Body

Comprehensive serializer for Lead model. Handles multilingual fields, sales stage relationships, and computed metrics like weighted value.

unique_idstring · max: 100 · nullableOptional

titlestring · min: 1Required

descriptionstring · nullableOptional

qualification_notesstring · nullableOptional

prioritystring · enumOptional

• low - Low
• medium - Medium
• high - High
• critical - Critical

Possible values:

lead_sourcestring · enumRequired

Select one of the predefined lead sources.

• website - Website
• social_media - Social Media
• email_marketing - Email Marketing
• referral - Referral
• cold_calling - Cold Calling
• trade_show - Trade Show
• advertising - Advertising
• content_marketing - Content Marketing
• seo - SEO
• ppc - Pay-per-Click
• partner - Partner
• other - Other

Possible values:

estimated_valuestring · decimal · nullableOptionalPattern: ^-?\d{0,16}(?:\.\d{0,2})?$

win_probabilitystring · decimal · nullableOptionalPattern: ^-?\d{0,3}(?:\.\d{0,2})?$

sales_stagestring · nullableRequired

Unique ID of an existing sales stage.

clientstring · nullableOptional

Unique ID of an existing client.

expected_close_datestring · date · nullableOptional

follow_up_datestring · date-time · nullableOptional

Responses

201Success

application/json

Comprehensive serializer for Lead model. Handles multilingual fields, sales stage relationships, and computed metrics like weighted value.

unique_idstring · max: 100 · nullableOptional

titlestringRequired

descriptionstring · nullableOptional

qualification_notesstring · nullableOptional

prioritystring · enumOptional

• low - Low
• medium - Medium
• high - High
• critical - Critical

Possible values:

lead_sourcestring · enumRequired

Select one of the predefined lead sources.

• website - Website
• social_media - Social Media
• email_marketing - Email Marketing
• referral - Referral
• cold_calling - Cold Calling
• trade_show - Trade Show
• advertising - Advertising
• content_marketing - Content Marketing
• seo - SEO
• ppc - Pay-per-Click
• partner - Partner
• other - Other

Possible values:

estimated_valuestring · decimal · nullableOptionalPattern: ^-?\d{0,16}(?:\.\d{0,2})?$

win_probabilitystring · decimal · nullableOptionalPattern: ^-?\d{0,3}(?:\.\d{0,2})?$

weighted_valuestring · decimal · nullableRead-onlyRequiredPattern: ^-?\d{0,16}(?:\.\d{0,2})?$

sales_stagestring · nullableRequired

Unique ID of an existing sales stage.

clientstring · nullableOptional

Unique ID of an existing client.

expected_close_datestring · date · nullableOptional

follow_up_datestring · date-time · nullableOptional

is_closedbooleanRead-onlyRequired

date_createdstring · date-timeRead-onlyRequired

last_updatedstring · date-timeRead-onlyRequired

400

Bad Request - invalid or missing fields

401

Unauthorized

403

Forbidden

post/api/v1.0/organisation/{org_uid}/leads/create/

POST /api/v1.0/organisation/{org_uid}/leads/create/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "unique_id": "text",
  "title": "text",
  "description": "text",
  "qualification_notes": "text",
  "priority": "low",
  "lead_source": "website",
  "estimated_value": "text",
  "win_probability": "text",
  "sales_stage": "text",
  "client": "text",
  "expected_close_date": "2026-01-01",
  "follow_up_date": "2026-01-01T00:00:00.000Z"
}

{
  "unique_id": "text",
  "title": "text",
  "description": "text",
  "qualification_notes": "text",
  "priority": "low",
  "lead_source": "website",
  "estimated_value": "text",
  "win_probability": "text",
  "weighted_value": "text",
  "sales_stage": "text",
  "client": "text",
  "expected_close_date": "2026-01-01",
  "follow_up_date": "2026-01-01T00:00:00.000Z",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "assigned_to": {
    "unique_id": "text",
    "full_name": "text"
  },
  "is_closed": true,
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

Get lead

get

/api/v1.0/organisation/{org_uid}/leads/{unique_id}/

Retrieve a specific lead

Authorizations

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Responses

200Success

application/json

Comprehensive serializer for Lead model. Handles multilingual fields, sales stage relationships, and computed metrics like weighted value.

unique_idstring · max: 100 · nullableOptional

titlestringRequired

descriptionstring · nullableOptional

qualification_notesstring · nullableOptional

prioritystring · enumOptional

• low - Low
• medium - Medium
• high - High
• critical - Critical

Possible values:

lead_sourcestring · enumRequired

Select one of the predefined lead sources.

• website - Website
• social_media - Social Media
• email_marketing - Email Marketing
• referral - Referral
• cold_calling - Cold Calling
• trade_show - Trade Show
• advertising - Advertising
• content_marketing - Content Marketing
• seo - SEO
• ppc - Pay-per-Click
• partner - Partner
• other - Other

Possible values:

estimated_valuestring · decimal · nullableOptionalPattern: ^-?\d{0,16}(?:\.\d{0,2})?$

win_probabilitystring · decimal · nullableOptionalPattern: ^-?\d{0,3}(?:\.\d{0,2})?$

weighted_valuestring · decimal · nullableRead-onlyRequiredPattern: ^-?\d{0,16}(?:\.\d{0,2})?$

sales_stagestring · nullableRequired

Unique ID of an existing sales stage.

clientstring · nullableOptional

Unique ID of an existing client.

expected_close_datestring · date · nullableOptional

follow_up_datestring · date-time · nullableOptional

is_closedbooleanRead-onlyRequired

date_createdstring · date-timeRead-onlyRequired

last_updatedstring · date-timeRead-onlyRequired

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v1.0/organisation/{org_uid}/leads/{unique_id}/

GET /api/v1.0/organisation/{org_uid}/leads/{unique_id}/ HTTP/1.1
Host: skhokho.ai
Accept: */*

{
  "unique_id": "text",
  "title": "text",
  "description": "text",
  "qualification_notes": "text",
  "priority": "low",
  "lead_source": "website",
  "estimated_value": "text",
  "win_probability": "text",
  "weighted_value": "text",
  "sales_stage": "text",
  "client": "text",
  "expected_close_date": "2026-01-01",
  "follow_up_date": "2026-01-01T00:00:00.000Z",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "assigned_to": {
    "unique_id": "text",
    "full_name": "text"
  },
  "is_closed": true,
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

Update lead

put

/api/v1.0/organisation/{org_uid}/leads/{unique_id}/update/

Update a specific lead (full or partial update).

Authorizations

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Body

Comprehensive serializer for Lead model. Handles multilingual fields, sales stage relationships, and computed metrics like weighted value.

unique_idstring · max: 100 · nullableOptional

titlestring · min: 1Required

descriptionstring · nullableOptional

qualification_notesstring · nullableOptional

prioritystring · enumOptional

• low - Low
• medium - Medium
• high - High
• critical - Critical

Possible values:

lead_sourcestring · enumRequired

Select one of the predefined lead sources.

• website - Website
• social_media - Social Media
• email_marketing - Email Marketing
• referral - Referral
• cold_calling - Cold Calling
• trade_show - Trade Show
• advertising - Advertising
• content_marketing - Content Marketing
• seo - SEO
• ppc - Pay-per-Click
• partner - Partner
• other - Other

Possible values:

estimated_valuestring · decimal · nullableOptionalPattern: ^-?\d{0,16}(?:\.\d{0,2})?$

win_probabilitystring · decimal · nullableOptionalPattern: ^-?\d{0,3}(?:\.\d{0,2})?$

sales_stagestring · nullableRequired

Unique ID of an existing sales stage.

clientstring · nullableOptional

Unique ID of an existing client.

expected_close_datestring · date · nullableOptional

follow_up_datestring · date-time · nullableOptional

Responses

200Success

application/json

Comprehensive serializer for Lead model. Handles multilingual fields, sales stage relationships, and computed metrics like weighted value.

unique_idstring · max: 100 · nullableOptional

titlestringRequired

descriptionstring · nullableOptional

qualification_notesstring · nullableOptional

prioritystring · enumOptional

• low - Low
• medium - Medium
• high - High
• critical - Critical

Possible values:

lead_sourcestring · enumRequired

Select one of the predefined lead sources.

• website - Website
• social_media - Social Media
• email_marketing - Email Marketing
• referral - Referral
• cold_calling - Cold Calling
• trade_show - Trade Show
• advertising - Advertising
• content_marketing - Content Marketing
• seo - SEO
• ppc - Pay-per-Click
• partner - Partner
• other - Other

Possible values:

estimated_valuestring · decimal · nullableOptionalPattern: ^-?\d{0,16}(?:\.\d{0,2})?$

win_probabilitystring · decimal · nullableOptionalPattern: ^-?\d{0,3}(?:\.\d{0,2})?$

weighted_valuestring · decimal · nullableRead-onlyRequiredPattern: ^-?\d{0,16}(?:\.\d{0,2})?$

sales_stagestring · nullableRequired

Unique ID of an existing sales stage.

clientstring · nullableOptional

Unique ID of an existing client.

expected_close_datestring · date · nullableOptional

follow_up_datestring · date-time · nullableOptional

is_closedbooleanRead-onlyRequired

date_createdstring · date-timeRead-onlyRequired

last_updatedstring · date-timeRead-onlyRequired

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

put/api/v1.0/organisation/{org_uid}/leads/{unique_id}/update/

PUT /api/v1.0/organisation/{org_uid}/leads/{unique_id}/update/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "unique_id": "text",
  "title": "text",
  "description": "text",
  "qualification_notes": "text",
  "priority": "low",
  "lead_source": "website",
  "estimated_value": "text",
  "win_probability": "text",
  "sales_stage": "text",
  "client": "text",
  "expected_close_date": "2026-01-01",
  "follow_up_date": "2026-01-01T00:00:00.000Z"
}

{
  "unique_id": "text",
  "title": "text",
  "description": "text",
  "qualification_notes": "text",
  "priority": "low",
  "lead_source": "website",
  "estimated_value": "text",
  "win_probability": "text",
  "weighted_value": "text",
  "sales_stage": "text",
  "client": "text",
  "expected_close_date": "2026-01-01",
  "follow_up_date": "2026-01-01T00:00:00.000Z",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "assigned_to": {
    "unique_id": "text",
    "full_name": "text"
  },
  "is_closed": true,
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

Update lead

patch

/api/v1.0/organisation/{org_uid}/leads/{unique_id}/update/

Update a specific lead (full or partial update).

Authorizations

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Body

Comprehensive serializer for Lead model. Handles multilingual fields, sales stage relationships, and computed metrics like weighted value.

unique_idstring · max: 100 · nullableOptional

titlestring · min: 1Optional

descriptionstring · nullableOptional

qualification_notesstring · nullableOptional

prioritystring · enumOptional

• low - Low
• medium - Medium
• high - High
• critical - Critical

Possible values:

lead_sourcestring · enumOptional

Select one of the predefined lead sources.

• website - Website
• social_media - Social Media
• email_marketing - Email Marketing
• referral - Referral
• cold_calling - Cold Calling
• trade_show - Trade Show
• advertising - Advertising
• content_marketing - Content Marketing
• seo - SEO
• ppc - Pay-per-Click
• partner - Partner
• other - Other

Possible values:

estimated_valuestring · decimal · nullableOptionalPattern: ^-?\d{0,16}(?:\.\d{0,2})?$

win_probabilitystring · decimal · nullableOptionalPattern: ^-?\d{0,3}(?:\.\d{0,2})?$

sales_stagestring · nullableOptional

Unique ID of an existing sales stage.

clientstring · nullableOptional

Unique ID of an existing client.

expected_close_datestring · date · nullableOptional

follow_up_datestring · date-time · nullableOptional

Responses

200Success

application/json

Comprehensive serializer for Lead model. Handles multilingual fields, sales stage relationships, and computed metrics like weighted value.

unique_idstring · max: 100 · nullableOptional

titlestringRequired

descriptionstring · nullableOptional

qualification_notesstring · nullableOptional

prioritystring · enumOptional

• low - Low
• medium - Medium
• high - High
• critical - Critical

Possible values:

lead_sourcestring · enumRequired

Select one of the predefined lead sources.

• website - Website
• social_media - Social Media
• email_marketing - Email Marketing
• referral - Referral
• cold_calling - Cold Calling
• trade_show - Trade Show
• advertising - Advertising
• content_marketing - Content Marketing
• seo - SEO
• ppc - Pay-per-Click
• partner - Partner
• other - Other

Possible values:

estimated_valuestring · decimal · nullableOptionalPattern: ^-?\d{0,16}(?:\.\d{0,2})?$

win_probabilitystring · decimal · nullableOptionalPattern: ^-?\d{0,3}(?:\.\d{0,2})?$

weighted_valuestring · decimal · nullableRead-onlyRequiredPattern: ^-?\d{0,16}(?:\.\d{0,2})?$

sales_stagestring · nullableRequired

Unique ID of an existing sales stage.

clientstring · nullableOptional

Unique ID of an existing client.

expected_close_datestring · date · nullableOptional

follow_up_datestring · date-time · nullableOptional

is_closedbooleanRead-onlyRequired

date_createdstring · date-timeRead-onlyRequired

last_updatedstring · date-timeRead-onlyRequired

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

patch/api/v1.0/organisation/{org_uid}/leads/{unique_id}/update/

PATCH /api/v1.0/organisation/{org_uid}/leads/{unique_id}/update/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "unique_id": "text",
  "title": "text",
  "description": "text",
  "qualification_notes": "text",
  "priority": "low",
  "lead_source": "website",
  "estimated_value": "text",
  "win_probability": "text",
  "sales_stage": "text",
  "client": "text",
  "expected_close_date": "2026-01-01",
  "follow_up_date": "2026-01-01T00:00:00.000Z"
}

{
  "unique_id": "text",
  "title": "text",
  "description": "text",
  "qualification_notes": "text",
  "priority": "low",
  "lead_source": "website",
  "estimated_value": "text",
  "win_probability": "text",
  "weighted_value": "text",
  "sales_stage": "text",
  "client": "text",
  "expected_close_date": "2026-01-01",
  "follow_up_date": "2026-01-01T00:00:00.000Z",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "assigned_to": {
    "unique_id": "text",
    "full_name": "text"
  },
  "is_closed": true,
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

Delete lead

delete

/api/v1.0/organisation/{org_uid}/leads/{unique_id}/delete/

Delete a specific lead

Authorizations

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Responses

204

No Content

No content

401

Unauthorized

403

Forbidden

404

Not Found

delete/api/v1.0/organisation/{org_uid}/leads/{unique_id}/delete/

DELETE /api/v1.0/organisation/{org_uid}/leads/{unique_id}/delete/ HTTP/1.1
Host: skhokho.ai
Accept: */*

No content