TRANXACT.AI Help

CRM · Sales

Leads

Read and maintain leads records (crm.leads).

Type REST17 operationsBase path /api/crm/leadsPublished as /api/v1/leads

Download specification (OpenAPI 3.1) Screen: Leads

Overview

PackageCRM
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold CRM › Leads on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablecrm.leads · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

17 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/crm/leadsList leads

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "source": "web",
      "company": "text",
      "contact_name": "Example",
      "email": "someone@example.com",
      "phone": "+1 555 0100",
      "score": 10,
      "score_factors": {},
      "status": "draft",
      "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "converted_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "created_at": "2026-10-30T09:00:00Z",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/crm/leads?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/leads/{id}Read one leads

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source": "web",
  "company": "text",
  "contact_name": "Example",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "score": 10,
  "score_factors": {},
  "status": "draft",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "converted_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/leadsCreate a leads

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
sourcetextNoSource
Allowed: web event referral partner import campaign outbound other
companytextYesCompany
contact_nametextNoContact name
emailtextNoEmail
phonetextNoPhone
statustextNoStatus
websitetextNoWebsite — The company’s web address, for example https://example.com
job_titletextNoJob title
industrytextNoIndustry
Allowed: Manufacturing Healthcare Financial services Retail Technology Professional services Education Government Construction Logistics Energy Hospitality
company_sizetextNoCompany size
Allowed: 1-10 11-50 51-200 201-500 501-1000 1001-5000 5000+
linkedin_urltextNoLinkedIn profile
citytextNoCity
countrytextNoCountry
notestextNoNotes
statetextNoState / province — Chosen from the country’s own list where there is one, typed where there is not.
postal_codetextNoPostal / ZIP code
address_line1textNoAddress line 1
address_line2textNoAddress line 2
metro_areatextNoMetro area
annual_revenuenumericNoAnnual revenue
sic_codetextNoSIC code — US Standard Industrial Classification. Shown for a company in the United States, Canada or Mexico.
naics_codetextNoNAICS code — North American Industry Classification System. Shown for a company in the United States, Canada or Mexico.
locations_countintegerNoNumber of locations
fiscal_year_endtextNoFiscal year end — As the company states it, e.g. December or 31-Mar.
owner_nametextNoLead owner — Left empty, lead routing assigns an owner where it is set up.
ownership_typetextNoOwnership type
Allowed: Public Private Subsidiary Government Partnership Non-profit Other
descriptiontextNoAbout the company
lead_grouptextNoLead group
contact_first_nametextNoContact first name — The person at the company, if you know one yet; the people at a lead are kept under Lead contacts.
contact_last_nametextNoContact last name
campaign_iduuidNoCampaign — The campaign that produced this lead.
personal_emailtextNoPersonal email

Sample body

{
  "company": "text",
  "source": "web",
  "contact_name": "Example",
  "email": "someone@example.com",
  "phone": "+1 555 0100"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source": "web",
  "company": "text",
  "contact_name": "Example",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "score": 10,
  "score_factors": {},
  "status": "draft",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "converted_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/leads" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"company":"text","source":"web","contact_name":"Example","email":"someone@example.com","phone":"+1 555 0100"}'
PUT/api/crm/leads/{id}Change a leads

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
sourcetextNoSource
Allowed: web event referral partner import campaign outbound other
companytextYesCompany
contact_nametextNoContact name
emailtextNoEmail
phonetextNoPhone
statustextNoStatus
websitetextNoWebsite — The company’s web address, for example https://example.com
job_titletextNoJob title
industrytextNoIndustry
Allowed: Manufacturing Healthcare Financial services Retail Technology Professional services Education Government Construction Logistics Energy Hospitality
company_sizetextNoCompany size
Allowed: 1-10 11-50 51-200 201-500 501-1000 1001-5000 5000+
linkedin_urltextNoLinkedIn profile
citytextNoCity
countrytextNoCountry
notestextNoNotes
statetextNoState / province — Chosen from the country’s own list where there is one, typed where there is not.
postal_codetextNoPostal / ZIP code
address_line1textNoAddress line 1
address_line2textNoAddress line 2
metro_areatextNoMetro area
annual_revenuenumericNoAnnual revenue
sic_codetextNoSIC code — US Standard Industrial Classification. Shown for a company in the United States, Canada or Mexico.
naics_codetextNoNAICS code — North American Industry Classification System. Shown for a company in the United States, Canada or Mexico.
locations_countintegerNoNumber of locations
fiscal_year_endtextNoFiscal year end — As the company states it, e.g. December or 31-Mar.
owner_nametextNoLead owner — Left empty, lead routing assigns an owner where it is set up.
ownership_typetextNoOwnership type
Allowed: Public Private Subsidiary Government Partnership Non-profit Other
descriptiontextNoAbout the company
lead_grouptextNoLead group
contact_first_nametextNoContact first name — The person at the company, if you know one yet; the people at a lead are kept under Lead contacts.
contact_last_nametextNoContact last name
campaign_iduuidNoCampaign — The campaign that produced this lead.
personal_emailtextNoPersonal email

Sample body

{
  "company": "text",
  "source": "web"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source": "web",
  "company": "text",
  "contact_name": "Example",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "score": 10,
  "score_factors": {},
  "status": "draft",
  "owner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "converted_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"company":"text","source":"web"}'
DELETE/api/crm/leads/{id}Delete a leads

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/leads/{id}/score-explanationScore explanation

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/score-explanation" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/leads/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/crm/leads/{parentId}/contactsContacts

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contacts" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/leads/{parentId}/contactsContacts

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contacts" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/leads/{parentId}/contacts/{lineId}Contacts

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contacts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/leads/{parentId}/contacts/{lineId}Contacts

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contacts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/leads/{parentId}/activitiesActivities

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/activities" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/leads/{parentId}/activitiesActivities

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/activities" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/leads/{parentId}/activities/{lineId}Activities

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/activities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/leads/{parentId}/activities/{lineId}Activities

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/activities/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/leads/{id}/scoreScore

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/score" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/leads/{id}/convertConvert

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

accountId

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/leads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/convert" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"accountId":"value"}'

Data model

Every field of a leads, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
sourcetextread, writeSource
Allowed: web event referral partner import campaign outbound other
companytextread, writeCompany
contact_nametextread, writeContact name
emailtextread, writeEmail
phonetextread, writePhone
scoreintegerread onlyScore
score_factorsjsonbread onlyScore factors
statustextread, writeStatus
owner_iduuidread onlyOwner id
converted_account_iduuidread onlyConverted account id
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
location_iduuidread onlyLocation id
warehouse_iduuidread onlyWarehouse id
websitetextread, writeWebsite — The company’s web address, for example https://example.com
job_titletextread, writeJob title
industrytextread, writeIndustry
Allowed: Manufacturing Healthcare Financial services Retail Technology Professional services Education Government Construction Logistics Energy Hospitality
company_sizetextread, writeCompany size
Allowed: 1-10 11-50 51-200 201-500 501-1000 1001-5000 5000+
linkedin_urltextread, writeLinkedIn profile
citytextread, writeCity
countrytextread, writeCountry
notestextread, writeNotes
statetextread, writeState / province — Chosen from the country’s own list where there is one, typed where there is not.
postal_codetextread, writePostal / ZIP code
address_line1textread, writeAddress line 1
address_line2textread, writeAddress line 2
metro_areatextread, writeMetro area
annual_revenuenumericread, writeAnnual revenue
sic_codetextread, writeSIC code — US Standard Industrial Classification. Shown for a company in the United States, Canada or Mexico.
naics_codetextread, writeNAICS code — North American Industry Classification System. Shown for a company in the United States, Canada or Mexico.
locations_countintegerread, writeNumber of locations
fiscal_year_endtextread, writeFiscal year end — As the company states it, e.g. December or 31-Mar.
owner_nametextread, writeLead owner — Left empty, lead routing assigns an owner where it is set up.
ownership_typetextread, writeOwnership type
Allowed: Public Private Subsidiary Government Partnership Non-profit Other
descriptiontextread, writeAbout the company
lead_grouptextread, writeLead group
contact_first_nametextread, writeContact first name — The person at the company, if you know one yet; the people at a lead are kept under Lead contacts.
contact_last_nametextread, writeContact last name
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
score_gradetextread onlyScore grade
score_model_iduuidread onlyScore model id
scored_attimestamp with time zoneread onlyScored at
routed_attimestamp with time zoneread onlyRouted at
closed_reasontextread onlyClosed reason
campaign_iduuidread, writeCampaign — The campaign that produced this lead.
personal_emailtextread, writePersonal email

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold CRM › Leads for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.