INinkbox
Identities

Get Identity

Changed on
get/api/v1/identities/{agent_handle}

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/identities/{agent_handle}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

agent_handlestring required

Response

Successful Response

idstring uuid required
organization_idstring required
agent_handlestring required
display_namestring nullable
descriptionstring nullable
status'active' | 'paused' | 'deleted'
whatsapp_enabledboolean
whatsapp_configuredboolean
whatsapp_numberstring nullable
imessage_enabledboolean
contact_sharing_enabledboolean
imessage_filter_mode'whitelist' | 'blacklist'
mail_filter_mode'whitelist' | 'blacklist'
phone_filter_mode'whitelist' | 'blacklist'
slack_filter_mode'whitelist' | 'blacklist'
slack_inbound_filter_mode'whitelist' | 'blacklist'
slack_outbound_filter_mode'whitelist' | 'blacklist'
mail_inbound_filter_mode'whitelist' | 'blacklist'
mail_outbound_filter_mode'whitelist' | 'blacklist'
phone_inbound_filter_mode'whitelist' | 'blacklist'
phone_outbound_filter_mode'whitelist' | 'blacklist'
email_addressstring email nullable
has_avatarboolean
created_atstring date-time required
updated_atstring date-time required
signing_key_configuredboolean
signing_key_created_atstring date-time nullable

Changes

  • 7e848337e8bfRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 43519e4ad6d8Revision changes
    • info

      added the optional property // to the response with the status