> ## 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 list of all team members and their associated campaigns.
# Get Team Senders
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.
;
};
The response includes details for each sender, such as their user ID and a list of campaigns they are involved in. Each campaign object contains the campaign ID, name, status, and the various sending channels used (e.g., LinkedIn, email).
This information is useful for tracking campaign participation and channel utilization by different team members.
## OpenAPI
````yaml get /team/senders
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:
/team/senders:
get:
tags:
- Team
summary: Get Team Senders
parameters:
- name: state
in: query
required: false
description: >-
Filter by campaign's state (running, paused, draft, ended, archived,
errors)
example: running
schema:
type: string
enum:
- running
- paused
- draft
- ended
- archived
- errors
responses:
'200':
headers:
Content-Type:
schema:
type: string
example: application/json
description: Success
content:
application/json:
schema:
type: array
items:
type: object
properties:
userId:
type: string
campaigns:
type: array
items:
type: object
properties:
_id:
type: string
name:
type: string
status:
type: string
sendingChannels:
type: array
items:
type: string
example:
- userId: usr_QB6kKK1wv68DujOET
campaigns:
- _id: cam_tBpHORyt3WhTQoi5A
name: Onboarding
status: paused
sendingChannels:
- email
- manual
- linkedinVisit
- _id: cam_O3BQOaXuyUuyqEHug
name: Community Launch
status: running
sendingChannels:
- email
- manual
- linkedinVisit
- _id: cam_NTJ1rituEQ61jVl6p
name: Email Warmup Test
status: ended
sendingChannels:
- email
- manual
- linkedinVisit
- _id: cam_1kESsVXFMzfrJImNc
name: Product Launch Campaign
status: draft
sendingChannels:
- email
- manual
- linkedinVisit
- userId: usr_v5xz8De4nsLeNWAfv
campaigns:
- _id: cam_fDwCRnYtL1cfwcA7k
name: WhatsApp Outreach
status: draft
sendingChannels:
- email
- whatsappMessage
- _id: cam_WBCWNrsoMKkCWWLqw
name: WhatsApp Test Campaign
status: ended
sendingChannels:
- email
- whatsappMessage
- userId: usr_rhhX1KT0qgOGCOrgE
campaigns:
- _id: cam_pCi08vhGoho2oK3YR
name: Networking
status: running
sendingChannels:
- email
- linkedinSend
- linkedinVisit
- linkedinInvite
- _id: cam_zhcBovstiHVaV1abf
name: Product Tools Campaign
status: paused
sendingChannels:
- email
- linkedinSend
- linkedinVisit
- linkedinInvite
'400':
description: Bad params (invalid state parameter)
content:
text/plain:
example: Bad params (invalid state parameter)
'401':
description: The authentication you supplied is incorrect
content:
text/plain:
example: The authentication you supplied is incorrect
'405':
description: Method not allowed
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
````