Leads

People or companies that have shown interest and are not yet customers.

GET List leads
POST Create a lead
GET Get a lead
PATCH Update a lead
DELETE Archive a lead

#List leads

GET/api/v1/leads

Operation list_leads · needs scope leads:read

Parameter	In	Type	Notes
`limit`	query	integer	Page size, at most 100.
`cursor`	query	string	`pagination.nextCursor` from the previous page.
`sort`	query	-updated_at \| updated_at \| -created_at \| created_at	Sort order. A leading minus sorts descending.
`updated_since`	query	datetime	Only records updated at or after this instant.
`q`	query	string	Free-text search over the object's main columns.
`status`	query	string	Only records whose status equals this.
`source`	query	string	Only records whose source equals this.
`owner`	query	string	Only records whose owner equals this.
`person`	query	string	Only records linked to this person (public id).
`company`	query	string	Only records linked to this company (public id).

bash

curl https://synconone.com/api/v1/leads \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

json

{
  "data": [
    {
      "id": "pr_1a2b3c4d5e6f7a8b",
      "object": "string",
      "person": "string",
      "company": "string",
      "title": "Annual plan renewal",
      "status": "new",
      "source": "website",
      "owner": "string",
      "score_band": "hot",
      "score_total": 1
    }
  ],
  "pagination": {
    "nextCursor": null,
    "hasMore": false
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Create a lead

POST/api/v1/leads

Operation create_lead · needs scope leads:write

Built-in and custom fields by key. Relations take public ids.

Body field	Type	Notes
`person`	string	Customer
`company`	string	Company
`title`	string	Title
`status`	new \| working \| qualified \| meeting \| converted \| disqualified	Status
`source`	website \| manual \| import \| conversation	Source
`owner`	string	Owner
`estimated_value_cents`	number	Estimated value
`requirements`	string	What they need
`campaign`	string	Campaign
`description`	string	Notes
`next_action_at`	string	Next action
`lost_reason`	string	Reason

bash

curl -X POST https://synconone.com/api/v1/leads \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"person":"string","company":"string","title":"Annual plan renewal","status":"new","source":"website"}'

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "person": "string",
    "company": "string",
    "title": "Annual plan renewal",
    "status": "new",
    "source": "website",
    "owner": "string",
    "score_band": "hot",
    "score_total": 1
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 409: Conflict, approval required, or idempotent request in progress. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Get a lead

GET/api/v1/leads/{id}

Operation get_lead · needs scope leads:read

Parameter	In	Type	Notes
`id` required	path	string	Public id of the lead.

bash

curl https://synconone.com/api/v1/leads/pr_1a2b3c4d5e6f7a8b \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "person": "string",
    "company": "string",
    "title": "Annual plan renewal",
    "status": "new",
    "source": "website",
    "owner": "string",
    "score_band": "hot",
    "score_total": 1
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 404: Not found, or not visible to this key. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Update a lead

PATCH/api/v1/leads/{id}

Operation update_lead · needs scope leads:write

Only the keys sent are changed. Fields are applied in order; the first refusal stops the request and details.applied lists what was already changed.

Parameter	In	Type	Notes
`id` required	path	string	Public id of the lead.

Body field	Type	Notes
`company`	string	Company
`title`	string	Title
`status`	new \| working \| qualified \| meeting \| converted \| disqualified	Status
`source`	website \| manual \| import \| conversation	Source
`owner`	string	Owner
`estimated_value_cents`	number	Estimated value
`requirements`	string	What they need
`campaign`	string	Campaign
`description`	string	Notes
`next_action_at`	string	Next action
`lost_reason`	string	Reason

bash

curl -X PATCH https://synconone.com/api/v1/leads/pr_1a2b3c4d5e6f7a8b \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company":"string","title":"Annual plan renewal","status":"new","source":"website","owner":"string"}'

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "person": "string",
    "company": "string",
    "title": "Annual plan renewal",
    "status": "new",
    "source": "website",
    "owner": "string",
    "score_band": "hot",
    "score_total": 1
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 404: Not found, or not visible to this key. · 409: Conflict, approval required, or idempotent request in progress. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Archive a lead

DELETE/api/v1/leads/{id}

Operation archive_lead · needs scope leads:write

Archives the record (it can be restored in the app). Nothing is destroyed.

Parameter	In	Type	Notes
`id` required	path	string	Public id of the lead.

bash

curl -X DELETE https://synconone.com/api/v1/leads/pr_1a2b3c4d5e6f7a8b \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "archived": true
  }
}