amb-routing-rules

List Apple Messages for Business routing rules

Returns the workspace's Apple Messages for Business routing rules, highest precedence first. Rules run when a conversation is created, when a closed conversation reopens, and when a customer writes to a resolved conversation, matching its group and intent to a queue. A message without a group or intent routes on the conversation's stored values. Later messages while the conversation is open in the inbox retain its queue.

get/v1/amb/routing-rules

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/amb/routing-rules
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

business_account_idstring
Example:abz_01krdgeqcxet5s7t44vh8rt9mg

Keep only routing rules belonging to this business. Omit to return rules across all businesses in the workspace.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The workspace's routing rules, optionally filtered by business.

Example response

{
  "data": [
    {
      "created_at": "2026-05-20T09:14:52Z",
      "updated_at": "2026-05-25T16:42:01Z",
      "id": "arr_01krdgeqcxet5s7t44vh8rt9mg",
      "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
      "match_kind": "intent",
      "match_intent_id": "order_status",
      "match_group_id": "support",
      "queue": "billing",
      "precedence": 10
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.