# List conversations

**GET /conversations**

The calling agent's message threads, most recent message first, each with its participants, when its latest message was sent, and how many messages others have sent since the agent last read it. A thread with no messages yet is left out, as in the agent app's inbox. Reading never marks a thread read.

Requires the `conversations:read` scope. Rate budget: 60 calls per 1 minute per credential (the `list` class).


## Servers
- https://www.realscout.com/api/agent/v1: https://www.realscout.com/api/agent/v1 ()


## Authentication methods
- Bearer auth


## Parameters


### Query parameters

- **archived** (boolean)
  true for the threads the agent has archived; omit or false for the inbox.

- **contact_id** (string)
  Only threads with this contact; an id that is none of the agent's contacts is an empty page.

- **cursor** (string)
  Opaque cursor from the previous page's next_cursor; a cursor another list issued is refused.

- **limit** (integer)
  Page size, 1 to 100.



## Responses
### 200
OK
#### Headers

- **X-RateLimit-Limit** (integer)
  Calls allowed in the current window.

- **X-RateLimit-Remaining** (integer)
  Calls left in the current window.

- **X-RateLimit-Reset** (integer)
  Epoch seconds at which the window resets.


#### Body: application/json (object)
- **data** (array[object])

- **has_more** (boolean)

- **next_cursor** (string | null)
  Send as cursor for the next page; null on the last one.


### 400
The request is invalid; `field` names the offending input when there is one. A body that is not valid JSON is refused before the API runs, as a bare 400 with no body.

#### Body: application/json (object)
- **error** (object)


### 401
Invalid or missing bearer token.

#### Body: application/json (object)
- **error** (object)


### 403
The credential was not granted the scope this call requires.

#### Body: application/json (object)
- **error** (object)


### 404
Not found, or not yours: the two are indistinguishable on purpose.

#### Body: application/json (object)
- **error** (object)


### 429
Rate limit exceeded; `Retry-After` says when to try again.
#### Headers

- **Retry-After** (integer)
  Seconds until the budget refills.


#### Body: application/json (object)
- **error** (object)


### 500
Something went wrong on our side.

#### Body: application/json (object)
- **error** (object)



[Powered by Bump.sh](https://bump.sh)