V1/user
Update information about an user. Only fields that are specified in the request are updated.
Permissions
This endpoint requires the following permissions:
User:UpdateUserInfofor the user to update.
The identifier of the user to update information for.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
The first name of the user to update. If null, the first name is not modified.
The last name of the user to update. If null, the last name is not modified.
Whether to automatically recommend responses to the user if the user hasn't replied to the coach for a while. If null, the preference is not modified.
The preferred language for the user. The agent will attempt to converse to the user in this language if set. This field must be in the ISO 639-3 format.
If null, erase the user's preferred setting, and the specific language used will be the agent's default spoken language. In order to not update this field, leave it out of the request or
set it to an empty object (_NotSet).
{}A specific type to indicate that a field is not set in the request.
The user's timezone in the IANA tz database format. If not specified, the organization's timezone is used.
{}A specific type to indicate that a field is not set in the request.
Whether conversations are visible to the admins. If null, the preference is not modified.
Whether the user's user model is visible to the admins. If null, the preference is not modified.
A list of additional context to update. If null, the context is not modified.
POST /v1/{organization}/user/{requested_user_id}/user HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 238
{
"first_name": "text",
"last_name": "text",
"enable_response_recommendation": true,
"preferred_language": "aaa",
"timezone": "Africa/Abidjan",
"conversations_visible_to_admins": true,
"user_model_visible_to_admins": true,
"additional_context": [
"text"
]
}No content
Retrieve the user models for an user.
Permissions
This endpoint requires the following permissions:
User:GetUserModelfor the user to retrieve the user models for.
The ID of the user whose user models to retrieve.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
GET /v1/{organization}/user/{user_id}/user_model HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Accept: */*
{
"user_models": [
{
"content": "text",
"insight_ids": [
"text"
],
"dimensions": [
{
"description": "text",
"tags": [
"text"
]
}
]
}
],
"additional_context": [
"text"
]
}Send a magic link to the user's email to sign in.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
An Amigo platform link that the user gets redirected to after clicking the login link.
Email of the user. This must correspond to an existing, verified user in the Amigo platform.
POST /v1/{organization}/user/signin HTTP/1.1
Host: api.amigo.ai
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"redirect_link": "https://example.com",
"email": "[email protected]"
}{
"user_id": "text"
}Given an organization API key, issue an authorization token for the specified user. The token should then be attached to the Authorization header in subsequent Amigo API calls.
This is an alternative authorization method for users who cannot use the Amigo frontend to login and authenticate.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
POST /v1/{organization}/user/signin_with_api_key HTTP/1.1
Host: api.amigo.ai
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"id_token": "text",
"expires_at": "2025-06-24T20:31:25.403Z"
}Retrieve all users in an organization.
Permissions
This endpoint is impacted by the following permissions:
Only users that the authenticated user has the
User:GetUserInfopermission for are returned.
Whether the user is verified.
The ID of the user.
[]The email of the user,
[]The maximum number of users to retrieve.
100The token from the previous request to return the next page of users.
0The fields to sort the users by. Supported fields are first_name, last_name, email, user_stats.num_conversations, user_stats.num_messages, and user_stats.last_message_time. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
[]The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
GET /v1/{organization}/user/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Accept: */*
{
"users": [
{
"org_id": "text",
"user_id": "text",
"first_name": "text",
"last_name": "text",
"email": "text",
"user_stats": {
"num_conversations": 1,
"num_messages": 1,
"last_message_time": "2025-06-24T20:31:25.403Z"
},
"role": "text",
"preferences": {
"enable_response_recommendation": false,
"preferred_language": "text",
"conversations_visible_to_admins": true,
"user_model_visible_to_admins": true,
"timezone": "text"
}
}
],
"has_more": true,
"continuation_token": 1
}Invite a user to the Amigo platform. The endpoint will create a new user in the organization, linked to the supplied email address. The created user will remain in the unverified status and will not have access to most of Amigo's services.
If login_link is not-None, an email containing it will be sent to the user's email with descriptions indicating that this would allow the user to login
and start their Amigo experience. Otherwise, no email will be sent.
Permissions
This endpoint requires the following permissions:
User:InviteUseron the user to invite.The authenticated user must have greater privileges than the role assigned to the new user.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
The first name of the user.
The last name of the user.
The email of the user. This email uniquely identifies the user in the organization.
If specified, this link will be sent to the user's email as the link to start their Amigo experience. For Amigo's frontend, this would be the user's organization's login page with their email already filled in.
The role to assign to the user. Only roles that are returned from the Get roles endpoint are allowed.
If specified, the user's preferences will be set to this value instead of the organization default.
POST /v1/{organization}/user/invite HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 309
{
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"login_link": "https://example.com",
"role_name": "text",
"user_preferences": {
"enable_response_recommendation": false,
"preferred_language": "aaa",
"conversations_visible_to_admins": true,
"user_model_visible_to_admins": true,
"timezone": "Africa/Abidjan"
}
}{
"user_id": "text",
"verify_link": "text"
}Delete an user. This endpoint deletes the user from the Amigo system.
Permissions
This endpoint requires the following permissions:
User.DeleteUseron the user to delete.
The identifier of the user to delete.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
DELETE /v1/{organization}/user/{requested_user_id} HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Accept: */*
No content
Retrieve the external events for the specified user.
Permissions
This endpoint may be impacted by the following permissions:
Only external events that the authenticated user has the
User:GetExternalEventpermission on will be returned.
The ID of the user to retrieve external events for.
The IDs of the external events to retrieve.
[]The maximum number of external events to retrieve.
20The continuation token returned from the previous response to retrieve the next set of external events.
0The field to sort the external events by. Supported fields are type, starts_at, and ends_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
[]The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
GET /v1/{organization}/user/{user_id}/external_event HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Accept: */*
{
"external_events": [
{
"_id": "text",
"org_id": "text",
"user_id": "text",
"type": "text",
"starts_at": "2025-06-24T20:31:25.403Z",
"ends_at": "2025-06-24T20:31:25.403Z",
"description": "text",
"transcript": "text"
}
],
"has_more": true,
"continuation_token": 1
}Create an external event.
Permissions
This endpoint requires the following permissions:
User.CreateExternalEventfor this event.
The identifier of the user to create this event for.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
The type of this event.
The time when this event started in UTC.
The time whent this event ended in UTC.
A description of this event.
The transcript of this event.
POST /v1/{organization}/user/{requested_user_id}/external_event HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 132
{
"type": "text",
"starts_at": "2025-06-24T20:31:25.403Z",
"ends_at": "2025-06-24T20:31:25.403Z",
"description": "text",
"transcript": "text"
}{
"external_event_id": "text"
}Delete an external event.
Permissions
This endpoint requires the following permissions:
User.DeleteExternalEventfor this event.
The identifier of the user to create this event for.
The identifier of the external event to delete.
^[a-f0-9]{24}$The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
DELETE /v1/{organization}/user/{requested_user_id}/external_event/{external_event_id} HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Accept: */*
No content
Retrieve memories for the specified users.
Permissions
This endpoint may be impacted by the following permissions:
Only memories with references that the authenticated user has the
Conversation:GetMessagepermission on will be returned.
The ID of the user to retrieve memories for.
The IDs of the memories to retrieve.
[]The IDs of the conversations to retrieve memories from.
[]The maximum number of memories to retrieve.
50The continuation token returned from the previous response to retrieve the next set of memories.
0The field to sort the memories by. Supported fields are conversation_id and timestamp. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
[]The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
GET /v1/{organization}/user/{user_id}/memory HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Accept: */*
{
"memories": [
{
"id": "text",
"timestamp": "2025-06-24T20:31:25.403Z",
"conversation_id": "text",
"references": [
"text"
],
"content": "text",
"context": "text"
}
],
"has_more": true,
"continuation_token": 1
}Search users in the organization using their names or emails.
Permissions
This endpoint may be impacted by the following permissions:
Only users that the authenticated user has the
User:GetUserInfopermission for will be returned.
The search query. Any users whose name or email contains the query are returned.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
GET /v1/{organization}/user/search/ HTTP/1.1
Host: api.amigo.ai
Authorization: Bearer JWT
Accept: */*
{
"users": [
{
"org_id": "text",
"user_id": "text",
"first_name": "text",
"last_name": "text",
"email": "text",
"user_stats": {
"num_conversations": 1,
"num_messages": 1,
"last_message_time": "2025-06-24T20:31:25.403Z"
},
"role": "text",
"preferences": {
"enable_response_recommendation": false,
"preferred_language": "text",
"conversations_visible_to_admins": true,
"user_model_visible_to_admins": true,
"timezone": "text"
}
}
]
}Was this helpful?