Channels

List addresses

Every identifier this project has seen. An address appears the first time a message arrives from it, so this is what naturali has observed rather than a roster you maintain — most rows carry no action of their own and defer to the route table.

get/v1/projects/{project_id}/addresses

Request

  • Base URL: https://api.naturali.ai
  • URL: https://api.naturali.ai/v1/projects/{project_id}/addresses
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.naturali.ai/authorize, token URL https://api.naturali.ai/token, scopes: mcp:access)

Query parameters

limitinteger

Results per page, 1 to 100 (default 50). Above 100 it is clamped; below 1 or not an integer it is 400.

cursorstring

Opaque pagination cursor from a previous response's next_cursor.

Response

A page of addresses.

next_cursorstring nullable required

Example response

{
  "data": [
    {
      "action": "agent",
      "agent_id": "agent_V1StGXR8Z5jdHi6B",
      "text": "Subscribe at https://example.com/pricing",
      "language": "en-US",
      "config": {
        "media": {
          "audio": "transcribe"
        },
        "discord": {
          "allowed_role_ids": [
            "1290000000000000042"
          ]
        }
      },
      "id": "addr_V1StGXR8Z5jdHi6B",
      "project_id": "proj_V1StGXR8Z5jdHi6B",
      "identifier": "whatsapp:dm:5511999998888",
      "display_name": "Ana",
      "actor_id": "actor_V1StGXR8Z5jdHi6B"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.