Companies

List companies

GET

https://api.lelemon.cl

/v2/companies

Bearer (API key)

The companies the organization does business with, by name. Filter by q (part of the name), status or type. A company groups the contacts that work in it.

Required scope: contacts:read.

List companies › query Parameters

limit

integer · min: 1 · max: 100

Default: 20

cursor

string · maxLength: 512

The nextCursor of the previous page, with the same filters.

q

string

Part of the name, ignoring case.

status

string · enum

Enum values:

lead

active

paused

lost

type

string · enum

Enum values:

prospect

client

partner

vendor

List companies › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

List companies › Responses

CompanyList

object

string · enum · required

Enum values:

list

hasMore

boolean · required

nextCursor

string | null · required

Company[] · required

Create a company

POST

https://api.lelemon.cl

/v2/companies

Bearer (API key)

A company groups the contacts that work in it. Only name is required; type defaults to prospect and status to lead. rut is unique among the live companies of the organization: using one that is taken is a 409 conflict with param rut. To link a contact to the company, send companyId when you create or update the contact.

Required scope: companies:write.

Create a company › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Idempotency-Key

string · minLength: 1 · maxLength: 255

Makes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.

Create a company › Request Body

CreateCompany

name

string · minLength: 1 · maxLength: 255 · required

rut

string · minLength: 1 · maxLength: 20

Unique among the live companies of the organization.

type

string · enum

Enum values:

prospect

client

partner

vendor

Default: prospect

status

string · enum

Enum values:

lead

active

paused

lost

Default: lead

website

string · maxLength: 255

industry

string · minLength: 1 · maxLength: 120

source

string · minLength: 1 · maxLength: 50

notes

string · maxLength: 2000

Create a company › Responses

CompanyDetail

object

string · enum · required

Enum values:

company

id

string · required

name

string · required

rut

string | null · required

type

string · enum · required

What the company is for the organization.

Enum values:

prospect

client

partner

vendor

status

string · enum · required

How the relationship is today.

Enum values:

lead

active

paused

lost

website

string | null · required

industry

string | null · required

source

string | null · required

notes

string | null · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

contactIds

string[] · required

The people of this company, as contact ids.

POST/v2/companies

curl https://api.lelemon.cl/v2/companies \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Panadería La Espiga",
  "rut": "76.123.456-7",
  "type": "client",
  "status": "active",
  "website": "laespiga.cl",
  "industry": "Food",
  "source": "referral",
  "notes": "Buys flour every week."
}'

Example Request Body

{
  "name": "Panadería La Espiga",
  "rut": "76.123.456-7",
  "type": "client",
  "status": "active",
  "website": "laespiga.cl",
  "industry": "Food",
  "source": "referral",
  "notes": "Buys flour every week."
}

json

application/json

Example Responses

{
  "object": "company",
  "id": "cpy_4Zq0x8bVw1TqS9mYp3RkLd",
  "name": "Panadería La Espiga",
  "rut": "76.123.456-7",
  "type": "prospect",
  "status": "lead",
  "website": "website",
  "industry": "industry",
  "source": "source",
  "notes": "notes",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "contactIds": [
    "ctc_4Zq0x8bVw1TqS9mYp3RkLd"
  ]
}

json

application/json

Retrieve a company

GET

https://api.lelemon.cl

/v2/companies/{id}

Bearer (API key)

Returns one company by id with the ids of its contacts. Use it to refresh a single record you already know; to find records, use the list route. Read only. 404 not_found when the id does not exist or belongs to another organization. You can repeat it safely: it has no side effects.

Required scope: contacts:read.

Retrieve a company › path Parameters

id

string · pattern: ^cpy_[0-9A-Za-z]{22}… · required

The id of the company (cpy_…).

Retrieve a company › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Retrieve a company › Responses

CompanyDetail

object

string · enum · required

Enum values:

company

id

string · required

name

string · required

rut

string | null · required

type

string · enum · required

What the company is for the organization.

Enum values:

prospect

client

partner

vendor

status

string · enum · required

How the relationship is today.

Enum values:

lead

active

paused

lost

website

string | null · required

industry

string | null · required

source

string | null · required

notes

string | null · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

contactIds

string[] · required

The people of this company, as contact ids.

Delete a company

DELETE

https://api.lelemon.cl

/v2/companies/{id}

Bearer (API key)

For data created by mistake: a company that was lost as a business is kept with status lost. Its contacts are not deleted: they stay and their companyId becomes null. The rut is free to use again. 404 not_found when the id does not exist or belongs to another organization.

Required scope: companies:write.

Delete a company › path Parameters

id

string · pattern: ^cpy_[0-9A-Za-z]{22}… · required

The id of the company (cpy_…).

Delete a company › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Delete a company › Responses

No data returned

Update a company

PATCH

https://api.lelemon.cl

/v2/companies/{id}

Bearer (API key)

Only the fields you send change. Send null in rut, website, industry, source or notes to remove it. A company that was lost as a business is not deleted: set its status to lost. Taking the rut of another live company is a 409 conflict with param rut.

Required scope: companies:write.

Update a company › path Parameters

id

string · pattern: ^cpy_[0-9A-Za-z]{22}… · required

The id of the company (cpy_…).

Update a company › Headers

Lelemon-Subaccount

string · pattern: ^sub_[0-9A-Za-z]{22}…

The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.

Update a company › Request Body optional

UpdateCompany

name

string · minLength: 1 · maxLength: 255

rut

string | null · minLength: 1 · maxLength: 20

null removes it.

type

string · enum

Enum values:

prospect

client

partner

vendor

status

string · enum

Enum values:

lead

active

paused

lost

website

string | null · maxLength: 255

null removes it.

industry

string | null · minLength: 1 · maxLength: 120

null removes it.

source

string | null · minLength: 1 · maxLength: 50

null removes it.

notes

string | null · maxLength: 2000

null removes it.

Update a company › Responses

CompanyDetail

object

string · enum · required

Enum values:

company

id

string · required

name

string · required

rut

string | null · required

type

string · enum · required

What the company is for the organization.

Enum values:

prospect

client

partner

vendor

status

string · enum · required

How the relationship is today.

Enum values:

lead

active

paused

lost

website

string | null · required

industry

string | null · required

source

string | null · required

notes

string | null · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

contactIds

string[] · required

The people of this company, as contact ids.

PATCH/v2/companies/{id}

curl https://api.lelemon.cl/v2/companies/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "status": "paused",
  "website": null,
  "notes": "Closed in January."
}'

Example Request Body

{
  "status": "paused",
  "website": null,
  "notes": "Closed in January."
}

json

application/json

Example Responses

{
  "object": "company",
  "id": "cpy_4Zq0x8bVw1TqS9mYp3RkLd",
  "name": "Panadería La Espiga",
  "rut": "76.123.456-7",
  "type": "prospect",
  "status": "lead",
  "website": "website",
  "industry": "industry",
  "source": "source",
  "notes": "notes",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "contactIds": [
    "ctc_4Zq0x8bVw1TqS9mYp3RkLd"
  ]
}

json

application/json

Contact fields Lead forms