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.
List Seats
Section titled “List Seats”Retrieve all seats for your account.
GET https://api.sendblue.co/api/v2/seatsQuery Parameters
Section titled “Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum number of seats to return |
offset | integer | No | Number of seats to skip (default: 0) |
email | string | No | Exact-match filter on seat email |
Example Request
Section titled “Example Request”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'Success Response (200)
Section titled “Success Response (200)”[ { "seat_id": "550e8400-e29b-41d4-a716-446655440000", "first_name": "Jane", "last_name": "Doe", "forwarding_number": "+19998887777", "account": "acmeco", "created_at": "2024-06-15T18:24:01.000Z" }]Get Seat Count
Section titled “Get Seat Count”Returns the number of seats on the account.
GET https://api.sendblue.co/api/v2/seats/countQuery Parameters
Section titled “Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | No | Exact-match filter on seat email |
Example Request
Section titled “Example Request”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'Success Response (200)
Section titled “Success Response (200)”{ "count": 12 }Get Single Seat
Section titled “Get Single Seat”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_idPath Parameters
Section titled “Path Parameters”| Parameter | Type | Description |
|---|---|---|
seat_id | string | Seat UUID or Firebase Auth subject |
Example Request
Section titled “Example Request”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'Success Response (200)
Section titled “Success Response (200)”{ "status": "OK", "seat": { "seat_id": "550e8400-e29b-41d4-a716-446655440000", "first_name": "Jane", "last_name": "Doe", "forwarding_number": "+19998887777", "account": "acmeco", "created_at": "2024-06-15T18:24:01.000Z" }}Error Response (404)
Section titled “Error Response (404)”{ "status": "ERROR", "message": "Seat not found" }Using seat_id for Message Attribution
Section titled “Using seat_id for Message Attribution”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.