Skip to the page

API reference

Get a chat

One chat and its participants.

GET/v1/chats/{id}

One chat and its participants.

Needs a key with the messages:read scope. Keys and scopes

Path parameters

  • idstringrequired

    The chat’s id.

    Starts with chat_.

Example

GET/v1/chats/chat_1Hq2LxW9cVbN3mKpRtYs0aGet a chat →
curl "https://usebluebot.com/api/v1/chats/chat_1Hq2LxW9cVbN3mKpRtYs0a" \
  -H "Authorization: Bearer $BLUEBOT_API_KEY"

Response

200: The chat.

  • idstringrequired

    A chat_ id.

    Starts with chat_.

  • object"chat"required
  • namestring or nullrequired

    The group’s name, when it has one.

  • is_groupbooleanrequired
  • participantsarray of stringsrequired

    The other people in the chat.

  • servicestring or nullrequired

    The chat’s service.

    One of imessage, sms.

  • last_message_attimestamp or nullrequired

    The newest text in the chat.

  • created_attimestamprequired

    When BlueBot first saw the chat.

Response200
{
  "id": "chat_1Hq2LxW9cVbN3mKpRtYs0a",
  "object": "chat",
  "name": "Oak St closing",
  "is_group": true,
  "participants": [
    "+15555550123",
    "+15555550187"
  ],
  "service": "imessage",
  "last_message_at": "2026-11-13T19:41:00.000Z",
  "created_at": "2026-11-02T14:00:00.000Z"
}

Errors

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

CodeStatusWhat it means
unauthorized401The request carried no key, or a key BlueBot doesn’t know: mistyped, revoked, or a test key sent to the live API.
insufficient_scope403The key doesn’t carry the scope the endpoint needs. Each endpoint’s reference names its scope.
rate_limited429Too 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.
internal500Something went wrong on BlueBot’s side. It was reported. Send the request again; with an Idempotency-Key that is always safe.
not_found404There is no such thing on this account. Ids are prefixed by kind, so a message id starts with msg_.

Try it

Call this operation from the page with your own key. The key stays in this tab and is forgotten when you leave.