> ## Documentation Index
> Fetch the complete documentation index at: https://lemlist-feat-add-assistant-to-contextual-options.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
> Retrieves the schema definition for companies in the people database.
# Get Companies Schema
export const SnippetObjectReference = ({objectName, objectPath = null}) => {
const lowerCaseObjectName = objectName.toLowerCase();
if (lowerCaseObjectName === 'lead' || lowerCaseObjectName === 'leads') {
return
This endpoint uses the {objectName} object. Make sure to also check the {lowerCaseObjectName === 'lead' ? 'Contact' : 'Lead'} object to understand the distinction between the two.
;
}
return
This endpoint uses the {objectName} object.
;
};
## OpenAPI
````yaml get /schema/companies
openapi: 3.0.0
info:
title: lemlist API
version: 1.0.0
description: >-
Welcome to the lemlist Developer Documentation.
lemlist is very customizable and open. You'll find on this page all the API
and integration you can do with lemlist.
# Rate Limit
lemlist's API rate limits requests in order to prevent abuse and overload of
our services.
Rate limits are applied on all routes and per API key performing the
request.
The rate limits are **20** requests per **2** seconds.
The response provides any information you may need about it:
| Header | Description |
| --- | --- |
| Retry-After | The number of seconds in which you can retry |
| X-RateLimit-Limit | The maximum requests in that time |
| X-RateLimit-Remaining | The number of remaining requests you can make |
| X-RateLimit-Reset | The date when the rate limit will reset |
_Example of values for the rate limit headers_
``` json
{
"Retry-After": 2,
"X-RateLimit-Limit": 20,
"X-RateLimit-Remaining": 7,
"X-RateLimit-Reset" : "Tue Feb 16 2021 09:02:42 GMT+0100 (Central European Standard Time)"
}
```
# Definitions
## Team
A team is the entity of lemlist that can handle users and billing.
## Credits
Credits are the coins a team uses to enrich emails, LinkedIn URLs, etc. via
the enrich route. Each enrichment feature needs a certain amount of credits
to run.
## User
You use a user account to connect to lemlist and send messages via the
connected emails or LinkedIn account.
## Campaign
A campaign is the entity to automate outreach. A campaign has multiple
sequences composed of steps.
## Lead
A lead is a person that you try to contact via a campaign.
## Activity
An activity is the history of all the steps.
## Unsubscribe
An unsubscribe occurs when a person decides they don't want to receive
emails from you anymore.
# Authentication
All API routes use the dedicated subdomain `api.lemlist.com`.
lemlist uses API keys to allow access to the API. You can get your lemlist
API key at our [integration
page](https://app.lemlist.com/settings/integrations).
You need to add the `Authorization` header using the `Basic` authentication
type. `login:password` **where the login is always empty and the password is
the API key**.
⚠️ **Don't forget to add the semicolon (**`:`**) before your API key in curl
command.**
> To authorize, use this code:
``` shell
curl https://api.lemlist.com/api/team \
--user ":YourApiKey"
```
**Make sure to replace** **`YourApiKey`** **with your API key.**
# Give feedback
If you want to report a bug, ask for data, or share with us a use case,
please fill this [form](https://lemlist.typeform.com/to/mfVlkyGf). It will
help us centralize your needs!
servers:
- url: https://api.lemlist.com/api
security:
- basicAuth: []
paths:
/schema/companies:
get:
tags:
- People Database
summary: Get Companies Schema
description: Get the schema definition for companies in the database
parameters: []
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
schema:
$ref: '#/components/schemas/CompaniesSchema'
type: object
version:
type: object
properties:
since:
type: integer
description: Version date in YYYYMMDD
type:
type: string
enum:
- date
required:
- since
- type
properties:
type: array
items:
type: string
example:
schema:
company_id: '88945664'
company_website_url: http://acme-tech.example.com
company_name: Acme Technologies
company_linkedin_url: https://www.linkedin.com/company/acme-technologies
last_updated: 2025-09-07 02:11:32 UTC
company_headquarters_city: Example City
company_headquarters_country: India
company_logo_url: https://example.com/logo1.png
company_description: >-
Acme, established on Aug-2015 with the idea "Make Your
Imagination Come True". Which means anyone who came up with
their idea, we will give a closely realistic solutions to
them.
company_employee_count: '31'
company_type: Public Company
company_founded: '2015'
company_size: 11-50
company_followers_count: '3958'
revenue_bucket: $5M - $10M
company_domain: acme-tech.example.com
employees_count_growth: -3
last_funding_round_at: More than 6 months
techno_used_array:
- Apache HTTP Server
- Lightbox
- LinkedIn Sales Navigator
- Postman
- React
- Node.js
- WordPress
- JavaScript
business_business_customer: B2B
company_quality_score: '3'
company_industry: Technology, Information and Media
company_subindustry: Technology, Information and Internet
company_subsubindustry: Software Development
company_location: 123 Example Street, Suite 100, Example City, Example Country
company_location_geopoint_array:
- 73.92
- 18.64
company_occ_lead: '60'
_score: 10.002095
_id: '88945664'
version:
since: 20251031
type: date
properties:
- company_id
- company_website_url
- company_name
- company_linkedin_url
- last_updated
- company_headquarters_city
- company_headquarters_country
- company_logo_url
- company_description
- company_employee_count
- company_type
- company_founded
- company_size
- company_followers_count
- revenue_bucket
- company_domain
- employees_count_growth
- last_funding_round_at
- techno_used_array
- business_business_customer
- company_quality_score
- company_industry
- company_subindustry
- company_subsubindustry
- company_location
- company_location_geopoint_array
- company_occ_lead
- _score
- _id
'400':
description: Bad team
content:
text/plain:
example: Bad team
'401':
description: The authentication you supplied is incorrect
content:
text/plain:
example: The authentication you supplied is incorrect
'405':
description: Method not allowed
components:
schemas:
CompaniesSchema:
type: object
description: A company record from lemlist's Companies database.
additionalProperties: true
properties:
company_id:
type: string
description: Unique company identifier
company_website_url:
type: string
format: uri
description: Official company website URL
company_name:
type: string
description: Company name
company_linkedin_url:
type: string
format: uri
description: LinkedIn company profile URL
last_updated:
type: string
description: Last update timestamp (UTC)
company_headquarters_city:
type: string
description: Headquarters city
company_headquarters_country:
type: string
description: Headquarters country
company_logo_url:
type: string
format: uri
description: Company logo image URL
company_description:
type: string
description: Long company description
company_employee_count:
type: string
description: Employee count as string
company_type:
type: string
description: Company type (e.g., Privately Held, Public Company)
company_founded:
type: string
description: Year founded as string
company_followers_count:
type: string
description: LinkedIn followers count as string
company_size:
type: string
description: Company size bucket
revenue_bucket:
type: string
description: Revenue range bucket
company_domain:
type: string
description: Company web domain
employees_count_growth:
type: integer
description: Employee count growth number
last_funding_round_at:
type: string
description: Date of last funding round
techno_used_array:
type: array
items:
type: string
description: Array of technologies used by the company
business_business_customer:
type: string
description: Customer type
enum:
- B2B
- B2C
- B2B2C
company_quality_score:
type: string
description: Quality score as string
company_industry:
type: string
description: Primary industry
company_subindustry:
type: string
description: Sub-industry
company_subsubindustry:
type: string
description: Sub-sub-industry
company_location:
type: string
description: Full formatted location
company_location_geopoint_array:
type: array
items:
type: number
description: Geopoint coordinates [longitude, latitude]
company_occ_lead:
type: string
description: Occupational lead count as string
_score:
type: number
description: Search relevance score
_id:
type: string
description: Internal document ID
securitySchemes:
basicAuth:
type: http
scheme: basic
````