π¨βπ»User Management
The AiKYNETIX Web API provides a comprehensive set of endpoints to manage user accounts and related administrative tasks.
Creating a New User
Administrators can create a new user by submitting a minimal JSON payload. The required fields include the user's email and display name, while the phone number is optional.
POST /user-management/users/Request Body Example
{
"email": "[email protected]",
"display_name": "User",
"phone": "932323232"
}Response
On success, a JSON object is returned containing the newly created userβs data:
{
"userData": {
"user_uid": "MYmC7MzsPBNU6uSQBnJ0",
"email": "[email protected]",
"display_name": "User",
"phone": "932323232"
}
}Updating User Details
Update an existing userβs profile by sending a JSON payload with the userβs unique identifier along with any new or updated fields. Additional profile attributes such as physical metrics and preferences can be included.
Endpoint
Request Body Example
Response
A successful update returns a confirmation message:
Retrieving Users
Administrators can retrieve a list of all users associated with their account. The API supports both simple and filtered retrieval, including pagination for large user bases.
List All Users
Endpoint:
Response Example:
Filtering and Pagination
Use query parameters to filter the list of users or paginate results:
start_after_id: UID after which to begin the list.
end_before_id: UID before which to end the list.
limit: Maximum number of users to return (default is 5).
Endpoint:
Example Request:
Response includes:
query_count: Total number of matching users.users: Array of user objects.first_uidandlast_uid: UIDs for pagination.
Retrieving Specific User Details
Retrieve detailed information for a specific user by providing their unique user UID.
Endpoint
Example Request
Example Response
Deleting a User
Administrators can delete a user from their account by providing the userβs unique UID in the request body.
Endpoint
Request Body Example
Response
A successful deletion returns a confirmation message:
Managing Sub-Admin Invitations and Assignments
Administrators can invite users to become sub-admins and manage sub-admin assignments.
List Invitations
Endpoint:
Retrieve a list of pending invitations. Each invitation includes details such as the inviterβs information, invitee email, and invitation status.
Create an Invitation
Endpoint:
Submit a JSON payload with the inviteeβs email (and optionally a platform link):
Remove an Invitation
Endpoint:
Provide the invite_token in the request body to remove the invitation.
Sub-Admin Management
Administrators can also retrieve, add, or remove sub-admins using the following endpoints:
Retrieve, Add and Remove Sub-Admins:
Retrieving Organization Status
Admins and sub-admins can retrieve organization status details including session count, user UID, role, payment type, and associated activities.
Endpoint
Example Response
Last updated
Was this helpful?