# Get a Text Hook

> One Text Hook with its address and mapping.

`GET /v1/hooks/{id}`

One Text Hook with its address and mapping.

Needs a key with the `messages:read` scope. [Keys and scopes](https://usebluebot.com/docs/concepts/api-keys)

## Path parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The Text Hook’s id. Starts with `hook_` |

## Example

```bash
curl "https://usebluebot.com/api/v1/hooks/hook_1Hq2LxW9cVbN3mKpRtYs0a" \
  -H "Authorization: Bearer $BLUEBOT_API_KEY"
```

```ts
import BlueBot from '@usebluebot/sdk';

const client = new BlueBot({ apiKey: process.env.BLUEBOT_API_KEY });

const hook = await client.hooks.get('hook_1Hq2LxW9cVbN3mKpRtYs0a');
console.log(hook);
```

```python
import os
from bluebot import BlueBot

client = BlueBot(api_key=os.environ["BLUEBOT_API_KEY"])

hook = client.hooks.get("hook_1Hq2LxW9cVbN3mKpRtYs0a")
print(hook)
```

## Response

`200`: The Text Hook.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | A hook_ id. Starts with `hook_` |
| `object` | "text_hook" | Yes |   |
| `name` | string | Yes |   |
| `url` | string | Yes | The address to post to. Anyone with it can send texts from your number, so keep it private. |
| `enabled` | boolean | Yes |   |
| `test_mode` | boolean | Yes | Posts are recorded and checked but no text is sent. |
| `mapping` | object | Yes | How a post becomes a text. Each value is a template over the posted fields: `body` for the JSON or form, `query` for the address’s query string. |
| `mapping.to` | string or null | Yes | Who to text, as a `{{body.…}}` path into the posted fields. Up to 200 characters |
| `mapping.text` | string or null | Yes | The words, with `{{body.…}}` fields. Leave it empty to use `template_id`. Up to 2,000 characters |
| `mapping.first_name` | string or null | Yes | Saved on the contact when it has no first name yet. Up to 200 characters |
| `mapping.last_name` | string or null | Yes | Up to 200 characters |
| `mapping.tags` | string or null | Yes | Tags to add, separated by commas. May use `{{body.…}}` fields. Up to 200 characters |
| `template_id` | string or null | Yes |   |
| `sequence_id` | string or null | Yes | A sequence each person is added to. Starts with `seq_` |
| `last_used_at` | timestamp or null | Yes | When it last received a post. |
| `created_at` | timestamp | Yes | When it was made. |

The answer, `200`:

```json
{
  "id": "hook_1Hq2LxW9cVbN3mKpRtYs0a",
  "object": "text_hook",
  "name": "Calendly bookings",
  "url": "https://usebluebot.com/h/th_8Rk2mQ4zN7wX1cVbL5pT9yHsQ2aVc0Ld",
  "enabled": true,
  "test_mode": false,
  "mapping": {
    "to": "{{body.payload.questions_and_answers.0.answer}}",
    "text": "Hi {{body.payload.name}}, you’re booked for {{body.payload.scheduled_event.start_time}}. Text back if anything changes.",
    "first_name": "{{body.payload.first_name}}",
    "last_name": "{{body.payload.last_name}}",
    "tags": "calendly"
  },
  "template_id": null,
  "sequence_id": null,
  "last_used_at": "2026-11-13T18:02:00.000Z",
  "created_at": "2026-11-03T16:00:00.000Z"
}
```

## Errors

Every refusal has the same envelope and a page of its own. These are the ones this operation can give.

| Code                                                    | Status | What it means                                                                                                                               |
| ------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
| [`unauthorized`](https://usebluebot.com/docs/errors/unauthorized)             | 401    | The request carried no key, or a key BlueBot doesn’t know: mistyped, revoked, or a test key sent to the live API.                           |
| [`insufficient_scope`](https://usebluebot.com/docs/errors/insufficient_scope) | 403    | The key doesn’t carry the scope the endpoint needs. Each endpoint’s reference names its scope.                                              |
| [`rate_limited`](https://usebluebot.com/docs/errors/rate_limited)             | 429    | Too many requests. A key may make 120 requests a minute. The `RateLimit` header says how many are left, and `Retry-After` how long to wait. |
| [`internal`](https://usebluebot.com/docs/errors/internal)                     | 500    | Something went wrong on BlueBot’s side. It was reported. Send the request again; with an Idempotency-Key that is always safe.               |
| [`not_found`](https://usebluebot.com/docs/errors/not_found)                   | 404    | There is no such thing on this account. Ids are prefixed by kind, so a message id starts with `msg_`.                                       |

## Try it