> ## Documentation Index
> Fetch the complete documentation index at: https://developer.lemlist.com/llms.txt
> Use this file to discover all available pages before exploring further.
> Retrieves a paginated list of all campaigns in your team.
# Get Many Campaigns
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.
;
};
Don't forget to set the query parameter version to `version=v2`.
## OpenAPI
````yaml get /campaigns
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:
/campaigns:
get:
tags:
- Campaigns
summary: Get Many Campaigns
parameters:
- name: offset
in: query
required: false
description: Offset from the start. For pagination.
example: '24'
schema:
type: integer
- name: limit
in: query
required: false
description: 'Number of campaigns to retrieve. Default: 100. Maximum: 100.'
example: '2'
schema:
type: integer
- name: version
in: query
required: false
description: Set to 'v2' to use the latest version
example: v2
schema:
type: string
default: v2
enum:
- v2
- name: page
in: query
required: false
description: Page number to retrieve
example: '1'
schema:
type: integer
- name: sortBy
in: query
required: false
description: >-
The field by which to sort. Currently, only 'createdAt' is
supported.
example: createdAt
schema:
type: string
enum:
- createdAt
- name: sortOrder
in: query
required: false
description: >-
The sort direction. Use 'desc' for descending order; any other value
(or omission) will sort in ascending order.
example: desc
schema:
type: string
enum:
- asc
- desc
- name: status
in: query
required: false
description: >-
The campaign status. Can be: running, draft, archived, ended,
paused, errors. Note: a campaign can be in multiple statuses at one
time (e.g., a paused campaign with errors).
example: running
schema:
type: string
enum:
- running
- draft
- archived
- ended
- paused
- errors
- name: createdBy
in: query
required: false
description: >-
Filter campaigns by creator user ID (usr_xxx format). Only returns
campaigns created by the specified user.
example: usr_QG9E94KvTmC7KWqzs
schema:
type: string
responses:
'200':
headers:
Content-Type:
schema:
type: string
example: application/json
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Campaign'
example:
- _id: cam_4HrZbi8xsez4QlrnL
name: Product Launch Campaign
labels: []
createdAt: '2025-02-20T14:45:54.230Z'
createdBy: usr_zdTCrNFyXblc4mrYK
status: running
hasError: true
errors:
- Your campaign does not have sender.
- _id: cam_k3gu2sa4KIfhRK34M
name: Sales Outreach 2025
labels: []
createdAt: '2025-02-05T09:00:07.541Z'
createdBy: usr_UEvrOEP0CTAYEoFR4
status: running
hasError: true
errors:
- One of your sender has no email provider.
- Your campaign have an invalid sender mailbox
- _id: cam_HcFmYEhnCI39Pscan
name: CRM Integration Test
labels:
- CRM
createdAt: '2023-01-27T14:58:52.482Z'
createdBy: usr_i52PiQtbq8SucjVTM
status: running
hasError: true
errors:
- One of your sender has no email provider.
- Your campaign have an invalid sender mailbox
- _id: cam_yZXeC6q3SXs3ha1FI
name: Customer Onboarding
labels: []
createdAt: '2022-06-14T13:32:57.880Z'
createdBy: usr_i52PiQtbq8SucjVTM
status: running
'400':
description: No API key provided
content:
text/plain:
example: No API key provided
'401':
description: The authentication you supplied is incorrect
content:
text/plain:
example: The authentication you supplied is incorrect
'403':
description: User linked to this API key is blocked
content:
text/plain:
example: User linked to this API key is blocked
'404':
description: No user found for this API key
content:
text/plain:
example: No user found for this API key
components:
schemas:
Campaign:
type: object
description: An automated outreach workflow containing sequences of steps.
properties:
_id:
type: string
description: Unique campaign identifier
name:
type: string
description: Campaign name
labels:
type: array
description: Categorization labels
items:
type: string
createdAt:
type: string
format: date-time
description: Creation timestamp
createdBy:
type: string
description: Creator user ID
status:
type: string
description: Campaign status
enum:
- running
- paused
- draft
- ended
- archived
- errors
sequenceId:
type: string
description: Main sequence ID
scheduleIds:
type: array
description: Associated schedule IDs
items:
type: string
teamId:
type: string
description: ID of the team that owns this campaign
hasError:
type: boolean
description: Whether the campaign has errors
errors:
type: array
description: List of error messages if campaign has errors
items:
type: string
creator:
type: object
description: Campaign creator information
properties:
userId:
type: string
description: Creator user ID
userEmail:
type: string
format: email
description: Creator email address
senders:
type: array
description: Campaign senders configuration
items:
type: object
properties:
id:
type: string
description: Sender user ID
email:
type: string
format: email
description: Sender email address
sendUserMailboxId:
type: string
description: Mailbox ID used for sending
securitySchemes:
basicAuth:
type: http
scheme: basic
````