User Profile | Infraon API Guide

Infraon API Guide

Product Docs

Gets a user profile with the given id

get

This endpoint is used to fetch a user in the current organization

Authorizations

Path parameters

idstringRequired

Responses

application/json

objectOptional

Serializes users querysets.

get

GET /ux/common/user/profile/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "profile_id": "text",
  "user": 1,
  "profile": "text",
  "creation_time": "2025-04-18T23:28:21.947Z",
  "profile_image": "text",
  "avatar": "text",
  "email": "text",
  "name": "text",
  "is_active": true,
  "last_loggged_in": "text",
  "customer_id": [],
  "customer_entity_id": [],
  "actual_username": "text",
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

Deletes the user with given id

delete

This endpoint is used to delete an existing user for the current organization

Authorizations

Path parameters

idstringRequired

Responses

delete

DELETE /ux/common/user/profile/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

application/json

objectOptional

Serializes users querysets.

get

GET /ux/common/user/profile/activeuser_list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "profile_id": "text",
  "user": 1,
  "profile": "text",
  "creation_time": "2025-04-18T23:28:21.947Z",
  "profile_image": "text",
  "avatar": "text",
  "email": "text",
  "name": "text",
  "is_active": true,
  "last_loggged_in": "text",
  "customer_id": [],
  "customer_entity_id": [],
  "actual_username": "text",
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

application/json

objectOptional

Serializes users querysets.

get

GET /ux/common/user/profile/download_csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "profile_id": "text",
  "user": 1,
  "profile": "text",
  "creation_time": "2025-04-18T23:28:21.947Z",
  "profile_image": "text",
  "avatar": "text",
  "email": "text",
  "name": "text",
  "is_active": true,
  "last_loggged_in": "text",
  "customer_id": [],
  "customer_entity_id": [],
  "actual_username": "text",
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

application/json

objectOptional

Serializes users querysets.

get

GET /ux/common/user/profile/getmyprofile/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "profile_id": "text",
  "user": 1,
  "profile": "text",
  "creation_time": "2025-04-18T23:28:21.947Z",
  "profile_image": "text",
  "avatar": "text",
  "email": "text",
  "name": "text",
  "is_active": true,
  "last_loggged_in": "text",
  "customer_id": [],
  "customer_entity_id": [],
  "actual_username": "text",
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

application/json

objectOptional

Serializes users querysets.

get

GET /ux/common/user/profile/options/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "profile_id": "text",
  "user": 1,
  "profile": "text",
  "creation_time": "2025-04-18T23:28:21.947Z",
  "profile_image": "text",
  "avatar": "text",
  "email": "text",
  "name": "text",
  "is_active": true,
  "last_loggged_in": "text",
  "customer_id": [],
  "customer_entity_id": [],
  "actual_username": "text",
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

Gets a list of user profiles

get

This endpoint is used to fetch all the users in the current organization (works based on token used to authorize)

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

application/json

objectOptional

get

GET /ux/common/user/profile/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Creates a new user

post

This endpoint is used to save a new user for the current organization

Authorizations

Body

Other propertiesanyOptional

Responses

application/json

anyOptional

post

POST /ux/common/user/profile/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 474

{
  "email": "test@everest.com",
  "name": "Test",
  "password": "ZDk5NjMwYmNjNzA1ODYzOWU3ZTgwZGYyMzlmMzhhMzI6OlUyRnNkR1ZrWDEvc0Jlb1BwcVYxcGViUWlucHFDTG1DdUlUanVMYWtzb1U9",
  "confirm_password": "ZDk5NjMwYmNjNzA1ODYzOWU3ZTgwZGYyMzlmMzhhMzI6OlUyRnNkR1ZrWDEvTUJhSkp2bENBQWlKdHBUOHVQY1ErdmZ6dnRhMkowMDg9",
  "landline": 801212121,
  "timezone": "time zone 1",
  "phone": "99999999",
  "dashboard": "1",
  "role": "",
  "is_active": true,
  "organization_role": "Manager",
  "first_name": "Test",
  "username": "test@everest.com"
}

201Success

{
  "status": "success",
  "user_id": 20,
  "message": "user created"
}

Edits the user with given id

put

This endpoint is used to edit an existing user for the current organization

Authorizations

Path parameters

idstringRequired

Body

Serializes users querysets.

profile_idstring · max: 25Required

userintegerOptional

profilestringRead-onlyRequired

creation_timestring · date-timeOptional

profile_imagestringRead-onlyRequired

avatarstringRead-onlyRequired

emailstring | nullableOptional

namestringRead-onlyRequired

is_activebooleanOptional

last_loggged_instringRead-onlyRequired

customer_idany[]Optional

customer_entity_idany[]Optional

actual_usernamestringRead-onlyRequired

is_multiple_customer_userbooleanOptional

is_profile_imagebooleanOptional

Responses

application/json

objectOptional

Serializes users querysets.

put

PUT /ux/common/user/profile/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "profile_id": "text",
  "user": 1,
  "creation_time": "2025-04-18T23:28:21.947Z",
  "email": "text",
  "is_active": true,
  "customer_id": [],
  "customer_entity_id": [],
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

200Success

{
  "profile_id": "text",
  "user": 1,
  "profile": "text",
  "creation_time": "2025-04-18T23:28:21.947Z",
  "profile_image": "text",
  "avatar": "text",
  "email": "text",
  "name": "text",
  "is_active": true,
  "last_loggged_in": "text",
  "customer_id": [],
  "customer_entity_id": [],
  "actual_username": "text",
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

Serializes users querysets.

profile_idstring · max: 25Required

userintegerOptional

profilestringRead-onlyRequired

creation_timestring · date-timeOptional

profile_imagestringRead-onlyRequired

avatarstringRead-onlyRequired

emailstring | nullableOptional

namestringRead-onlyRequired

is_activebooleanOptional

last_loggged_instringRead-onlyRequired

customer_idany[]Optional

customer_entity_idany[]Optional

actual_usernamestringRead-onlyRequired

is_multiple_customer_userbooleanOptional

is_profile_imagebooleanOptional

Responses

application/json

objectOptional

Serializes users querysets.

post

POST /ux/common/user/profile/active_users/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "profile_id": "text",
  "user": 1,
  "creation_time": "2025-04-18T23:28:21.947Z",
  "email": "text",
  "is_active": true,
  "customer_id": [],
  "customer_entity_id": [],
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

200Success

{
  "profile_id": "text",
  "user": 1,
  "profile": "text",
  "creation_time": "2025-04-18T23:28:21.947Z",
  "profile_image": "text",
  "avatar": "text",
  "email": "text",
  "name": "text",
  "is_active": true,
  "last_loggged_in": "text",
  "customer_id": [],
  "customer_entity_id": [],
  "actual_username": "text",
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

Serializes users querysets.

profile_idstring · max: 25Required

userintegerOptional

profilestringRead-onlyRequired

creation_timestring · date-timeOptional

profile_imagestringRead-onlyRequired

avatarstringRead-onlyRequired

emailstring | nullableOptional

namestringRead-onlyRequired

is_activebooleanOptional

last_loggged_instringRead-onlyRequired

customer_idany[]Optional

customer_entity_idany[]Optional

actual_usernamestringRead-onlyRequired

is_multiple_customer_userbooleanOptional

is_profile_imagebooleanOptional

Responses

application/json

objectOptional

Serializes users querysets.

post

POST /ux/common/user/profile/logout/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "profile_id": "text",
  "user": 1,
  "creation_time": "2025-04-18T23:28:21.947Z",
  "email": "text",
  "is_active": true,
  "customer_id": [],
  "customer_entity_id": [],
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

200Success

{
  "profile_id": "text",
  "user": 1,
  "profile": "text",
  "creation_time": "2025-04-18T23:28:21.947Z",
  "profile_image": "text",
  "avatar": "text",
  "email": "text",
  "name": "text",
  "is_active": true,
  "last_loggged_in": "text",
  "customer_id": [],
  "customer_entity_id": [],
  "actual_username": "text",
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

Serializes users querysets.

profile_idstring · max: 25Required

userintegerOptional

profilestringRead-onlyRequired

creation_timestring · date-timeOptional

profile_imagestringRead-onlyRequired

avatarstringRead-onlyRequired

emailstring | nullableOptional

namestringRead-onlyRequired

is_activebooleanOptional

last_loggged_instringRead-onlyRequired

customer_idany[]Optional

customer_entity_idany[]Optional

actual_usernamestringRead-onlyRequired

is_multiple_customer_userbooleanOptional

is_profile_imagebooleanOptional

Responses

application/json

objectOptional

Serializes users querysets.

post

POST /ux/common/user/profile/myprofile/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "profile_id": "text",
  "user": 1,
  "creation_time": "2025-04-18T23:28:21.947Z",
  "email": "text",
  "is_active": true,
  "customer_id": [],
  "customer_entity_id": [],
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

200Success

{
  "profile_id": "text",
  "user": 1,
  "profile": "text",
  "creation_time": "2025-04-18T23:28:21.947Z",
  "profile_image": "text",
  "avatar": "text",
  "email": "text",
  "name": "text",
  "is_active": true,
  "last_loggged_in": "text",
  "customer_id": [],
  "customer_entity_id": [],
  "actual_username": "text",
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

Serializes users querysets.

profile_idstring · max: 25Required

userintegerOptional

profilestringRead-onlyRequired

creation_timestring · date-timeOptional

profile_imagestringRead-onlyRequired

avatarstringRead-onlyRequired

emailstring | nullableOptional

namestringRead-onlyRequired

is_activebooleanOptional

last_loggged_instringRead-onlyRequired

customer_idany[]Optional

customer_entity_idany[]Optional

actual_usernamestringRead-onlyRequired

is_multiple_customer_userbooleanOptional

is_profile_imagebooleanOptional

Responses

application/json

objectOptional

Serializes users querysets.

post

POST /ux/common/user/profile/preference/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "profile_id": "text",
  "user": 1,
  "creation_time": "2025-04-18T23:28:21.947Z",
  "email": "text",
  "is_active": true,
  "customer_id": [],
  "customer_entity_id": [],
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

200Success

{
  "profile_id": "text",
  "user": 1,
  "profile": "text",
  "creation_time": "2025-04-18T23:28:21.947Z",
  "profile_image": "text",
  "avatar": "text",
  "email": "text",
  "name": "text",
  "is_active": true,
  "last_loggged_in": "text",
  "customer_id": [],
  "customer_entity_id": [],
  "actual_username": "text",
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

Serializes users querysets.

profile_idstring · max: 25Required

userintegerOptional

profilestringRead-onlyRequired

creation_timestring · date-timeOptional

profile_imagestringRead-onlyRequired

avatarstringRead-onlyRequired

emailstring | nullableOptional

namestringRead-onlyRequired

is_activebooleanOptional

last_loggged_instringRead-onlyRequired

customer_idany[]Optional

customer_entity_idany[]Optional

actual_usernamestringRead-onlyRequired

is_multiple_customer_userbooleanOptional

is_profile_imagebooleanOptional

Responses

application/json

objectOptional

Serializes users querysets.

post

POST /ux/common/user/profile/upload_csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "profile_id": "text",
  "user": 1,
  "creation_time": "2025-04-18T23:28:21.947Z",
  "email": "text",
  "is_active": true,
  "customer_id": [],
  "customer_entity_id": [],
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

200Success

{
  "profile_id": "text",
  "user": 1,
  "profile": "text",
  "creation_time": "2025-04-18T23:28:21.947Z",
  "profile_image": "text",
  "avatar": "text",
  "email": "text",
  "name": "text",
  "is_active": true,
  "last_loggged_in": "text",
  "customer_id": [],
  "customer_entity_id": [],
  "actual_username": "text",
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

Serializes users querysets.

profile_idstring · max: 25Required

userintegerOptional

profilestringRead-onlyRequired

creation_timestring · date-timeOptional

profile_imagestringRead-onlyRequired

avatarstringRead-onlyRequired

emailstring | nullableOptional

namestringRead-onlyRequired

is_activebooleanOptional

last_loggged_instringRead-onlyRequired

customer_idany[]Optional

customer_entity_idany[]Optional

actual_usernamestringRead-onlyRequired

is_multiple_customer_userbooleanOptional

is_profile_imagebooleanOptional

Responses

application/json

objectOptional

Serializes users querysets.

post

POST /ux/common/user/profile/user_invite/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "profile_id": "text",
  "user": 1,
  "creation_time": "2025-04-18T23:28:21.947Z",
  "email": "text",
  "is_active": true,
  "customer_id": [],
  "customer_entity_id": [],
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

200Success

{
  "profile_id": "text",
  "user": 1,
  "profile": "text",
  "creation_time": "2025-04-18T23:28:21.947Z",
  "profile_image": "text",
  "avatar": "text",
  "email": "text",
  "name": "text",
  "is_active": true,
  "last_loggged_in": "text",
  "customer_id": [],
  "customer_entity_id": [],
  "actual_username": "text",
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

Serializes users querysets.

profile_idstring · max: 25Required

userintegerOptional

profilestringRead-onlyRequired

creation_timestring · date-timeOptional

profile_imagestringRead-onlyRequired

avatarstringRead-onlyRequired

emailstring | nullableOptional

namestringRead-onlyRequired

is_activebooleanOptional

last_loggged_instringRead-onlyRequired

customer_idany[]Optional

customer_entity_idany[]Optional

actual_usernamestringRead-onlyRequired

is_multiple_customer_userbooleanOptional

is_profile_imagebooleanOptional

Responses

application/json

objectOptional

Serializes users querysets.

post

POST /ux/common/user/profile/validate_csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "profile_id": "text",
  "user": 1,
  "creation_time": "2025-04-18T23:28:21.947Z",
  "email": "text",
  "is_active": true,
  "customer_id": [],
  "customer_entity_id": [],
  "is_multiple_customer_user": true,
  "is_profile_image": true
}

200Success

{
  "profile_id": "text",
  "user": 1,
  "profile": "text",
  "creation_time": "2025-04-18T23:28:21.947Z",
  "profile_image": "text",
  "avatar": "text",
  "email": "text",
  "name": "text",
  "is_active": true,
  "last_loggged_in": "text",
  "customer_id": [],
  "customer_entity_id": [],
  "actual_username": "text",
  "is_multiple_customer_user": true,
  "is_profile_image": true
}