Skip to content
Get Started
API v2

Seats API

List and retrieve seats (users) on your Sendblue account for message attribution

Retrieve the seats (users) on your account so you can attribute outbound messages to a specific rep using the seat_id parameter on the send endpoints.

The Seats API is read-only — seat creation, updates, and deletion happen through the Sendblue dashboard.

Retrieve all seats for your account.

GET https://api.sendblue.co/api/v2/seats
ParameterTypeRequiredDescription
limitintegerNoMaximum number of seats to return
offsetintegerNoNumber of seats to skip (default: 0)
emailstringNoExact-match filter on seat email
Terminal window
curl -X GET 'https://api.sendblue.co/api/v2/seats?limit=50' \
-H 'sb-api-key-id: YOUR_API_KEY' \
-H 'sb-api-secret-key: YOUR_API_SECRET'
[
{
"seat_id": "550e8400-e29b-41d4-a716-446655440000",
"email": "[email protected]",
"first_name": "Jane",
"last_name": "Doe",
"forwarding_number": "+19998887777",
"account": "acmeco",
"created_at": "2024-06-15T18:24:01.000Z"
}
]

Returns the number of seats on the account.

GET https://api.sendblue.co/api/v2/seats/count
ParameterTypeRequiredDescription
emailstringNoExact-match filter on seat email
Terminal window
curl -X GET 'https://api.sendblue.co/api/v2/seats/count' \
-H 'sb-api-key-id: YOUR_API_KEY' \
-H 'sb-api-secret-key: YOUR_API_SECRET'
{ "count": 12 }

Retrieve a single seat by its UUID or by its Firebase Auth subject — both identifiers resolve to the same seat.

GET https://api.sendblue.co/api/v2/seats/:seat_id
ParameterTypeDescription
seat_idstringSeat UUID or Firebase Auth subject
Terminal window
curl -X GET 'https://api.sendblue.co/api/v2/seats/550e8400-e29b-41d4-a716-446655440000' \
-H 'sb-api-key-id: YOUR_API_KEY' \
-H 'sb-api-secret-key: YOUR_API_SECRET'
{
"status": "OK",
"seat": {
"seat_id": "550e8400-e29b-41d4-a716-446655440000",
"email": "[email protected]",
"first_name": "Jane",
"last_name": "Doe",
"forwarding_number": "+19998887777",
"account": "acmeco",
"created_at": "2024-06-15T18:24:01.000Z"
}
}
{ "status": "ERROR", "message": "Seat not found" }

Pass any seat_id returned by this API on the /api/send-message, /api/send-carousel, or /api/send-group-message endpoints to attribute the message to that seat. The seat’s email is then auto-populated as sender_email on the message record and on webhook payloads.

If the supplied seat_id does not exist on your account, the send endpoint returns 400.