Account

Read your account data and the list of users.

Base URLhttps://app.syncro.chat/api/v1AuthX-API-Key: crm_SUA_CHAVE_AQUI

Account data

GET/account

Permission: users:read

Returns the basic data of the account that owns the API Key.

Request

curl "https://app.syncro.chat/api/v1/account" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"

Response

{
  "success": true,
  "account": {
    "id": 1,
    "name": "Minha Empresa",
    "plan": "scale"
  }
}

List users

GET/users

Permission: users:read

Lists the account users. The role field can be admin, manager or viewer.

Request

curl "https://app.syncro.chat/api/v1/users" \
  -H "X-API-Key: crm_SUA_CHAVE_AQUI"

Response

{
  "success": true,
  "data": [
    {
      "id": 12,
      "name": "Ana",
      "email": "[email protected]",
      "role": "admin"
    },
    {
      "id": 13,
      "name": "Bruno",
      "email": "[email protected]",
      "role": "manager"
    }
  ]
}