# Seats

## List seats

**get** `/api/v2/seats`

Retrieve a list of seats (users) for the authenticated company. Use the returned `seat_id`
values when sending messages with the `seat_id` parameter to attribute activity to a specific rep.

### Query Parameters

- `email: optional string`

  Optional exact-match filter on seat email

- `limit: optional number`

  Maximum number of seats to return

- `offset: optional number`

  Number of seats to skip

### Returns

- `account: optional string`

  Account name the seat belongs to

- `created_at: optional string`

  When the seat was created

- `email: optional string`

  Email address of the seat user

- `first_name: optional string`

  First name

- `forwarding_number: optional string`

  Optional phone number used to forward calls

- `last_name: optional string`

  Last name

- `seat_id: optional string`

  Primary identifier for the seat. Pass this on the send endpoints' `seat_id` parameter.

### Example

```http
curl https://api.sendblue.co/api/v2/seats \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET"
```

#### Response

```json
[
  {
    "account": "acmeco",
    "created_at": "2024-06-15T18:24:01Z",
    "email": "rep@example.com",
    "first_name": "Jane",
    "forwarding_number": "+19998887777",
    "last_name": "Doe",
    "seat_id": "550e8400-e29b-41d4-a716-446655440000"
  }
]
```

## Get seat count

**get** `/api/v2/seats/count`

Returns the number of seats for the authenticated company.

### Query Parameters

- `email: optional string`

  Optional exact-match filter on seat email

### Returns

- `count: optional number`

### Example

```http
curl https://api.sendblue.co/api/v2/seats/count \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET"
```

#### Response

```json
{
  "count": 12
}
```

## Get a seat

**get** `/api/v2/seats/{seat_id}`

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

### Path Parameters

- `seat_id: string`

### Returns

- `seat: optional object { account, created_at, email, 4 more }`

  - `account: optional string`

    Account name the seat belongs to

  - `created_at: optional string`

    When the seat was created

  - `email: optional string`

    Email address of the seat user

  - `first_name: optional string`

    First name

  - `forwarding_number: optional string`

    Optional phone number used to forward calls

  - `last_name: optional string`

    Last name

  - `seat_id: optional string`

    Primary identifier for the seat. Pass this on the send endpoints' `seat_id` parameter.

- `status: optional string`

### Example

```http
curl https://api.sendblue.co/api/v2/seats/$SEAT_ID \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET"
```

#### Response

```json
{
  "seat": {
    "account": "acmeco",
    "created_at": "2024-06-15T18:24:01Z",
    "email": "rep@example.com",
    "first_name": "Jane",
    "forwarding_number": "+19998887777",
    "last_name": "Doe",
    "seat_id": "550e8400-e29b-41d4-a716-446655440000"
  },
  "status": "OK"
}
```

## Domain Types

### Seat List Response

- `SeatListResponse = array of object { account, created_at, email, 4 more }`

  - `account: optional string`

    Account name the seat belongs to

  - `created_at: optional string`

    When the seat was created

  - `email: optional string`

    Email address of the seat user

  - `first_name: optional string`

    First name

  - `forwarding_number: optional string`

    Optional phone number used to forward calls

  - `last_name: optional string`

    Last name

  - `seat_id: optional string`

    Primary identifier for the seat. Pass this on the send endpoints' `seat_id` parameter.

### Seat Count Response

- `SeatCountResponse object { count }`

  - `count: optional number`

### Seat Retrieve Response

- `SeatRetrieveResponse object { seat, status }`

  - `seat: optional object { account, created_at, email, 4 more }`

    - `account: optional string`

      Account name the seat belongs to

    - `created_at: optional string`

      When the seat was created

    - `email: optional string`

      Email address of the seat user

    - `first_name: optional string`

      First name

    - `forwarding_number: optional string`

      Optional phone number used to forward calls

    - `last_name: optional string`

      Last name

    - `seat_id: optional string`

      Primary identifier for the seat. Pass this on the send endpoints' `seat_id` parameter.

  - `status: optional string`