ARartil
Addresses

Read an address

Read one of an agent's addresses, with whether carriers are still registering its phone number.

get/agents/{id}/addresses/{addressId}

Request

  • Base URL
    https://app.artil.ai/api
  • URL
    https://app.artil.ai/api/agents/{id}/addresses/{addressId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://mcp.artil.ai/oauth/authorize
      Token URL: https://mcp.artil.ai/oauth/token scopes: agent

Path parameters

idstring uuid required

The agent's id

addressIdstring required

Response

The address

idstring uuid required
channel'email' | 'sms' | 'telegram' required
valuestring required

The email address, phone number or Telegram bot's @username

domainIdstring uuid nullable required

The workspace's own domain the address is on

primaryboolean required

Whether new messages on its channel go out from it

registeringboolean

Whether US carriers are still registering the phone number, which sends nothing until they have

createdAtstring date-time required

Changes

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