Inboxes

Returns the caller's inboxes. With user_id, returns a teammate's inboxes that have at least one source in a workspace the caller manages, showing only those sources.

get/v2/api/inboxes

Request

  • Base URL
    https://api.withallo.com
  • URL
    https://api.withallo.com/v2/api/inboxes
  • Auth
    API key in header Authorization

Query parameters

user_idstring
Example:usr-abc123

Act on a teammate's inbox (usr-*). The caller must be an admin or manager of that teammate's workspace, and only reaches inboxes and sources in workspaces they manage. Omit to act on your own inboxes.

Response

The inboxes

Example response

{
  "data": [
    {
      "id": "inb-abc123",
      "name": "Sales",
      "emoji": "💼",
      "sources": [
        {
          "allo_number": "+33612345678",
          "conditions": [
            {
              "node_id": "node-3",
              "digits": [
                "1"
              ]
            }
          ]
        }
      ],
      "filters": {
        "types": [
          "INBOUND_CALL"
        ],
        "user_ids": [],
        "contact_ids": [],
        "contact_list_ids": [],
        "tag_keys": [
          "porting"
        ]
      }
    }
  ]
}

Changes