# Identity: threads

> Message threads, newest first, with unread counts; One thread by its id, whatever page it is on, with its unread count; The newest messages in one thread, oldest first within the window; The owner has read this thread, through the message `through` names or, with no body, all of it (SPEC §7.6)

## Message threads, newest first, with unread counts

`GET /v1/identities/{slug}/threads` · operation `listThreads`

Requires the `batondeck:messages:read` permission (action `message:read`).

**Parameters**

| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| `slug` | path | string | yes |  |
| `limit` | query | integer | yes |  |
| `cursor` | query | string |  |  |

**Responses**

| Status | Meaning |
|---|---|
| 200 | Message threads, newest first, with unread counts |
| 400 | The arguments did not validate. |
| 401 | No portal session, and no live API key. |
| 403 | The policy refused, or the request was cross-site. |
| 404 | No such resource, or none this session may see. |

<details>
<summary>200 response schema</summary>

```json
{
  "type": "object",
  "properties": {
    "threads": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "contact_fpr": {
            "type": "string"
          },
          "topic": {
            "type": "string"
          },
          "last_at": {
            "type": "number"
          },
          "unread": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "contact_fpr",
          "topic",
          "last_at",
          "unread"
        ],
        "additionalProperties": false
      }
    },
    "cursor": {
      "type": "string"
    }
  },
  "required": [
    "threads"
  ],
  "additionalProperties": false
}
```

</details>

```sh
curl -X GET 'https://api.batondeck.com/v1/identities/:slug/threads' \
  -H "Authorization: Bearer $BATONDECK_API_KEY"
```


## One thread by its id, whatever page it is on, with its unread count

`GET /v1/identities/{slug}/threads/{threadId}` · operation `getThread`

Requires the `batondeck:messages:read` permission (action `message:read`).

**Parameters**

| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| `slug` | path | string | yes |  |
| `threadId` | path | string | yes |  |

**Responses**

| Status | Meaning |
|---|---|
| 200 | One thread by its id, whatever page it is on, with its unread count |
| 401 | No portal session, and no live API key. |
| 403 | The policy refused, or the request was cross-site. |
| 404 | No such resource, or none this session may see. |

<details>
<summary>200 response schema</summary>

```json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "contact_fpr": {
      "type": "string"
    },
    "topic": {
      "type": "string"
    },
    "last_at": {
      "type": "number"
    },
    "unread": {
      "type": "number"
    }
  },
  "required": [
    "id",
    "contact_fpr",
    "topic",
    "last_at",
    "unread"
  ],
  "additionalProperties": false
}
```

</details>

```sh
curl -X GET 'https://api.batondeck.com/v1/identities/:slug/threads/:threadId' \
  -H "Authorization: Bearer $BATONDECK_API_KEY"
```


## The newest messages in one thread, oldest first within the window

`GET /v1/identities/{slug}/threads/{threadId}/messages` · operation `listMessages`

Requires the `batondeck:messages:read` permission (action `message:read`).

**Parameters**

| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| `slug` | path | string | yes |  |
| `threadId` | path | string | yes |  |
| `limit` | query | integer | yes |  |

**Responses**

| Status | Meaning |
|---|---|
| 200 | The newest messages in one thread, oldest first within the window |
| 400 | The arguments did not validate. |
| 401 | No portal session, and no live API key. |
| 403 | The policy refused, or the request was cross-site. |
| 404 | No such resource, or none this session may see. |

<details>
<summary>200 response schema</summary>

```json
{
  "type": "object",
  "properties": {
    "thread_id": {
      "type": "string"
    },
    "trust": {
      "type": "string"
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "thread_id": {
            "type": "string"
          },
          "contact_fpr": {
            "type": "string"
          },
          "direction": {
            "type": "string",
            "enum": [
              "in",
              "out"
            ]
          },
          "sender": {
            "type": "string",
            "enum": [
              "agent",
              "human"
            ]
          },
          "body": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "reply_to": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "created_at": {
            "type": "number"
          },
          "expires_at": {
            "type": "number"
          },
          "attempts": {
            "type": "number"
          },
          "last_refusal": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "thread_id",
          "contact_fpr",
          "direction",
          "sender",
          "body",
          "kind",
          "reply_to",
          "status",
          "created_at",
          "expires_at",
          "attempts",
          "last_refusal"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "thread_id",
    "trust",
    "messages"
  ],
  "additionalProperties": false
}
```

</details>

```sh
curl -X GET 'https://api.batondeck.com/v1/identities/:slug/threads/:threadId/messages' \
  -H "Authorization: Bearer $BATONDECK_API_KEY"
```


## The owner has read this thread, through the message `through` names or, with no body, all of it (SPEC §7.6)

`POST /v1/identities/{slug}/threads/{threadId}/read` · operation `markThreadRead`

Requires the `batondeck:messages:read` permission (action `message:read`).

**Parameters**

| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| `slug` | path | string | yes |  |
| `threadId` | path | string | yes |  |

**Request body** (`application/json`)

| Field | Type | Required | Notes |
|---|---|---|---|
| `through` | string |  | ≥ 1 chars |

<details>
<summary>Request schema</summary>

```json
{
  "type": "object",
  "properties": {
    "through": {
      "type": "string",
      "minLength": 1
    }
  },
  "additionalProperties": false
}
```

</details>

**Responses**

| Status | Meaning |
|---|---|
| 200 | The owner has read this thread, through the message `through` names or, with no body, all of it (SPEC §7.6) |
| 400 | The arguments did not validate. |
| 401 | No portal session, and no live API key. |
| 403 | The policy refused, or the request was cross-site. |
| 404 | No such resource, or none this session may see. |

<details>
<summary>200 response schema</summary>

```json
{
  "type": "object",
  "properties": {
    "thread_id": {
      "type": "string"
    },
    "unread": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "thread_id",
    "unread"
  ],
  "additionalProperties": false
}
```

</details>

```sh
curl -X POST 'https://api.batondeck.com/v1/identities/:slug/threads/:threadId/read' \
  -H "Authorization: Bearer $BATONDECK_API_KEY" \
  -H 'content-type: application/json' \
  -d @body.json
```