Enterprises, users and user groups management

Manage the organization of users into enterprises and user groups

Enterprises, users, and user groups are the core building blocks for managing access, organization, and reporting in the platform.

Enterprises define the organizational boundaries for customers or tenants.
Users represent individual accounts that interact with the system.
User Groups organize users into teams, departments, or functional units for easier assignment, permissions management, and reporting.

This section explains how to manage these entities through the API, with practical use cases and endpoint references to help you:

Onboard and organize team members.
Maintain and update group memberships
Password management

Entity

What it is

What it’s used for

Enterprise

A customer account or tenant in the platform.

- Groups all users, groups, tickets, and resources under one organization.

- Defines settings, quotas, and branding at the organization level.

- Serves as the scope for reporting and statistics.

Service

A functional configuration or capability linked to an enterprise, often enabling a specific set of features.

- Defines how certain functionalities (e.g., conferences, tickets) are available to an enterprise.

- Used to manage feature sets and technical settings.

User Group

A team or collection of users within an enterprise.

- Organizes users by department, function, or permissions.

- Controls routing rules and skills for its members.

- Enables team-level reporting and management.

User

An individual account with login credentials and assigned roles.

- Acts as an agent, admin, or other role within an enterprise.

- Participates in tickets or conferences.

- Belongs to one enterprise and to one or more user groups to control routing.

Manage users in an enterprise

Get all users of an enterprise

Endpoint: GET /api/v3/enterprises/{enterpriseId}/users Retrieve a list of all users belonging to a specific enterprise.

When to use:

Display the full directory of an enterprise.
Prepare for bulk operations such as assigning users to groups.

Get all users of one enterprise

get

/api/v3/enterprises/{enterpriseId}/users

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

enterpriseIdintegerRequired

Id of the enterprise

Responses

200

Returns enterprise stats

application/json

Responseany

400

Error case when enterpriseId is not set

application/json

403

Different kind of responses

application/json

get

/api/v3/enterprises/{enterpriseId}/users

GET /api/v3/enterprises/{enterpriseId}/users HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "users": [
    {
      "id": 12,
      "userId": 12,
      "profileId": 25,
      "enterprise": {
        "id": 12,
        "name": "My enterprise name",
        "logo": "https://cloud.apizee.com/img/users/xxxxxx/default",
        "domain": "my.domain.com",
        "apiKey": "51az89eaz1a5z16az1az598"
      },
      "nickname": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "username": "my.username@email.com",
      "is_agent": "false",
      "email": "my.email@email.com",
      "photo_url": "https://cloud.apizee.com/img/users/xxxxxx/default",
      "title": "agent",
      "phone": "XXXXXXXXX",
      "mobile": "XXXXXXXXX"
    }
  ]
}

Create a new user

Endpoint: POST /api/v3/users Add a new user to the system.

When to use:

Onboard a new agent or admin.
Automate user creation from an external system.

Create a new user

post

/api/v3/users

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

usernamestringRequired

Username used to login

passwordstring · passwordRequired

Password used to login

emailstringOptional

User email. Required if no cell phone

cell_phonestringOptional

User cell phone. Required if no email

firstNamestringOptional

User firstName

lastNamestringOptional

The user lastName

enterpriseIdintegerOptional

By default enterprise id is given by user token

Responses

200

Different kind of responses

application/json

Responseany

500

Error case when there is a technical error

application/json

post

/api/v3/users

POST /api/v3/users?username=text&password=password HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "resultCode": "OK",
  "userId": "12"
}

Update user properties

Endpoint: PUT /api/v3/users Modify a user’s profile or settings.

When to use:

Update contact details or role.
Adjust permissions without recreating the account.

Update one user properties

put

/api/v3/users

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

UseridintegerRequired

User id

firstNamestringOptional

User first name

lastNamestringOptional

User last name

avatarstringOptional

User avatar

phoneNumberstringOptional

User phone number

jobTitlestringOptional

User job title

audioOnlyintegerOptional

Audio only

clickToChatintegerOptional

Click to chat

maxOngoingChatintegerOptional

Max on going chat

Responses

200

Returns userId in case of success

application/json

Responseany

400

Error case when the Userid parameter doesn't match any user

application/json

403

Error case when the user referenced by the token parameter doesn't have permission or rights to change user informations

application/json

500

Error case when there is a technical error

application/json

put

/api/v3/users

PUT /api/v3/users?Userid=1 HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "userId": "12"
}

Delete user

Endpoint: DELETE /api/v3/users Remove a user account.

When to use:

Offboard a departing employee.
Clean up inactive or duplicate accounts.

Delete user

delete

/api/v3/users

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

userIdintegerRequired

User id

Responses

200

Different kind of responses

application/json

Responseany

403

Error case when Usertoken header is invalid

application/json

delete

/api/v3/users

DELETE /api/v3/users?userId=1 HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "resultCode": "OK",
  "userId": "12"
}

Manage user groups

Get all user groups of an enterprise

Endpoint: GET /api/v3/enterprises/{enterpriseId}/groups Retrieve all user groups within an enterprise.

When to use:

Review available teams for assignment.
Audit organizational structure.

Get all groups of one enterprise

get

/api/v3/enterprises/{enterpriseId}/groups

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

enterpriseIdintegerRequired

Id of the enterprise

Responses

200

Good case

application/json

Responseany

403

Forbidden

application/json

404

404 Resource Not Found

application/json

get

/api/v3/enterprises/{enterpriseId}/groups

GET /api/v3/enterprises/{enterpriseId}/groups HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 103,
    "name": "Sales Team",
    "description": "Sales representatives for North America",
    "external_reference": null
  },
  {
    "id": 104,
    "name": "Engineering",
    "description": "Research and Development division",
    "external_reference": null
  }
]

Get all users in a user group

Endpoint: GET /api/v3/enterprises/{enterpriseId}/groups/{groupId}/members Retrieve all users assigned to a group.

When to use:

Review team composition.
Prepare for team restructuring.

Get all members from a enterprise group

get

/api/v3/enterprises/{enterpriseId}/groups/{groupId}/members

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

enterpriseIdintegerRequired

Id of the enterprise

groupIdintegerRequired

Id of the group

Responses

200

Good case

application/json

Responseany

403

Forbidden

application/json

404

404 Resource Not Found

application/json

get

/api/v3/enterprises/{enterpriseId}/groups/{groupId}/members

GET /api/v3/enterprises/{enterpriseId}/groups/{groupId}/members HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Manage user accounts and credentials

Get personal information of current authenticated user

Endpoint: GET /api/v3/users/me Retrieve the profile of the currently authenticated user.

When to use:

Display user details in self-service portals.
Pre-fill account settings forms.

Get personnal informations

get

/api/v3/users/me

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Return personnal informations

application/json

Responseany

403

Error case when Usertoken header is invalid

application/json

get

/api/v3/users/me

GET /api/v3/users/me HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "photo_url": "https://my.site.com/root/to/photo.jpg",
  "enterpriseId": 15,
  "userId": 12,
  "apiKey": "aze41989caz26a2z4e98c",
  "nickname": "John Doe",
  "token": "6a54c065a8z91a6z19a",
  "is_agent": "true",
  "ccs": "ccs.apizee.com"
}

Get user id

Endpoint: GET /api/v3/users/id Retrieve the ID of a user from email address.

When to use:

Get a user’s ID before performing updates or assignments.

Get user id

get

/api/v3/users/id

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

emailstringRequired

User email (used for login)

Responses

200

Different kind of responses

application/json

Responseany

403

Error case when Usertoken header is invalid

get

/api/v3/users/id

GET /api/v3/users/id?email=text HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "userId": "12",
  "enterpriseOd": 18,
  "firstName": "John",
  "lastName": "Doe",
  "resultCode": "OK"
}

Change user password

We recommend to use the endpoint /user/password/reset that manage to generate and transmit a new password to the user.

Endpoint: POST /api/v3/users/password/reset Send a password reset link by email.

When to use:

Help a user regain access.
Enforce password rotation.
Bulk reset password in cas of a security event.

Send an email with a reset password link to a user

post

/api/v3/users/password/reset

Query parameters

loginstringRequired

User login

Responses

200

Returns OK in case of success

application/json

Responseany

400

Different kind of responses

application/json

post

/api/v3/users/password/reset

POST /api/v3/users/password/reset?login=text HTTP/1.1
Host: cloud.apizee.com
Accept: */*

{
  "resultCode": "OK"
}

PreviousVideo conference management NextSnapshots and recordings

Last updated 2 months ago

hashtagManage users in an enterprise

hashtagGet all users of an enterprise

hashtagGet all users of one enterprise

hashtagCreate a new user

hashtagCreate a new user

hashtagUpdate user properties

hashtagUpdate one user properties

hashtagDelete user

hashtagDelete user

hashtagManage user groups

hashtagGet all user groups of an enterprise

hashtagGet all groups of one enterprise

hashtagGet all users in a user group

hashtagGet all members from a enterprise group

hashtagManage user accounts and credentials

hashtagGet personal information of current authenticated user

hashtagGet personnal informations

hashtagGet user id

hashtagGet user id

hashtagChange user password

hashtagSend an email with a reset password link to a user

Manage users in an enterprise

Get all users of an enterprise

Get all users of one enterprise

Create a new user

Create a new user

Update user properties

Update one user properties

Delete user

Delete user

Manage user groups

Get all user groups of an enterprise

Get all groups of one enterprise

Get all users in a user group

Get all members from a enterprise group

Manage user accounts and credentials

Get personal information of current authenticated user

Get personnal informations

Get user id

Get user id

Change user password

Send an email with a reset password link to a user