Skip to main content
GET
/
api
/
v1
/
profile
Fetch user profile
curl --request GET \
  --url https://connect.voxys.ai/api/v1/profile \
  --header 'api_access_token: <api-key>'
{
  "id": 123,
  "access_token": "<string>",
  "account_id": 123,
  "available_name": "<string>",
  "avatar_url": "<string>",
  "confirmed": true,
  "display_name": "<string>",
  "message_signature": "<string>",
  "email": "<string>",
  "hmac_identifier": "<string>",
  "inviter_id": 123,
  "name": "<string>",
  "provider": "<string>",
  "pubsub_token": "<string>",
  "ui_settings": {},
  "uid": "<string>",
  "type": "<string>",
  "custom_attributes": {},
  "accounts": [
    {
      "id": 123,
      "name": "<string>",
      "status": "<string>",
      "active_at": "2023-11-07T05:31:56Z",
      "permissions": [
        "<string>"
      ],
      "availability": "<string>",
      "availability_status": "<string>",
      "auto_offline": true,
      "custom_role_id": 123,
      "custom_role": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.voxys.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Response

Success

​
id
number
​
access_token
string
​
account_id
number
​
available_name
string
​
avatar_url
string
​
confirmed
boolean
​
display_name
string | null
​
message_signature
string | null
​
email
string
​
hmac_identifier
string
​
inviter_id
number | null
​
name
string
​
provider
string
​
pubsub_token
string
​
role
enum<string>
Available options:
agent,
administrator
​
ui_settings
object
​
uid
string
​
type
string | null
​
custom_attributes
object

Available for users who are created through platform APIs and has custom attributes associated.

​
accounts
object[]