Skip to the page

API reference

List the stop list

People BlueBot won’t text, newest first: those who texted a stop word and those you added.

GET/v1/stops

People BlueBot won’t text, newest first: those who texted a stop word and those you added.

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

Query parameters

  • limitinteger

    How many to return, 1 to 100. Default 25.

    1 to 100.Default 25.

  • cursorstring

    The next_cursor of the page before. Leave it out for the first page.

    Up to 200 characters.

Example

curl "https://usebluebot.com/api/v1/stops" \
  -H "Authorization: Bearer $BLUEBOT_API_KEY"

Response

200: A page of stops.

  • object"list"required
  • dataarray of Stoprequired
    Show its 5 fields
    • object"stop"required
    • handlestringrequired

      A phone number in E.164 (+15555550123) or an email address an Apple ID uses (iMessage only).

    • contact_idstringrequired

      A ct_ id.

      Starts with ct_.

    • stopped_attimestamprequired

      When they were put on the list.

    • sourcestringrequired

      reply (they texted a stop word), dashboard, api, import or admin.

      One of reply, dashboard, api, import, admin.

  • has_morebooleanrequired

    Whether another page follows.

  • next_cursorstring or nullrequired

    Send as cursor for the next page; null on the last.

Response200
{
  "object": "list",
  "data": [
    {
      "object": "stop",
      "handle": "+15555550144",
      "contact_id": "ct_4Mr6NdF1jHwS8aPxQcUv3e",
      "stopped_at": "2026-11-10T22:05:00.000Z",
      "source": "reply"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

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.
invalid_request400Something in the request doesn’t fit: a missing or malformed field, a bad id, or a combination the endpoint refuses. details names each field.

Try it

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