Product DocsSchemaAuthentication

Requester

Gets a list of requester profiles

get

This endpoint is used to fetch all the requester 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
200Success
application/json
get
GET /ux/common/requester/profile/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Creates a new requester

post

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

Authorizations
Body
Other propertiesanyOptional
Responses
201
No response body
post
POST /ux/common/requester/profile/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1183

{
  "full_name": "Vinutha K",
  "email": "[email protected]",
  "phone_number": "9980778899",
  "phone_ext": "91",
  "land_line": "201330",
  "is_login_active": true,
  "is_login_enable": true,
  "type": "internal",
  "notify_email": [
    "[email protected]"
  ],
  "notify_phone": [
    "8877667788"
  ],
  "tags": [
    "test",
    "dns"
  ],
  "support_hub": "Bangalore",
  "designation": "Manager",
  "department": "IT",
  "organization_name": "everest",
  "emp_type": "test",
  "customer_id": "123",
  "subscriber_id": "123",
  "customer_site_group": "cust_12",
  "joining_date": "",
  "business_segment": "1",
  "req_category": "1",
  "business_entity": "eve",
  "branch_partner": "eve",
  "sub_partner": "eve",
  "subscriber_status": "Pending",
  "user_details": {
    "username": "vinutha",
    "password": "ZDk5NjMwYmNjNzA1ODYzOWU3ZTgwZGYyMzlmMzhhMzI6OlUyRnNkR1ZrWDEvc0Jlb1BwcVYxcGViUWlucHFDTG1DdUlUanVMYWtzb1U9",
    "confirm_password": "ZDk5NjMwYmNjNzA1ODYzOWU3ZTgwZGYyMzlmMzhhMzI6OlUyRnNkR1ZrWDEvTUJhSkp2bENBQWlKdHBUOHVQY1ErdmZ6dnRhMkowMDg9",
    "reporting_id": "2"
  },
  "location": {
    "street": "7th Main",
    "building": "Building A",
    "area": "Jp Nagar",
    "sub_area": "JP Nagar",
    "city": "Bangalore",
    "state": "Karnataka",
    "country": "India",
    "pincode": "574221",
    "region": "South",
    "longitude": "78.01",
    "latitude": "12.3",
    "address": "JP Nagar"
  }
}
201

No response body

No content

Gets a requester profile with the given id

get

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

Authorizations
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /ux/common/requester/profile/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "requester_id": "text",
  "full_name": "text",
  "email": "text",
  "username": "text",
  "phone_ext": "text",
  "contact_number": "text",
  "land_line": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "phone_number": "text",
  "user_id": 1,
  "department": "text",
  "requester_type": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "notify_email": "text",
  "notify_phone": "text",
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "organization_name": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "contact": "text",
  "unmasked_full_name": "text",
  "unmasked_email": "text",
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}

Edits the requester with given id

put

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

Authorizations
Path parameters
idstringRequired
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

requester_idstring · max: 25Required
full_namestringRead-onlyRequired
emailstringRead-onlyRequired
usernamestring | nullableOptional
phone_extstringRead-onlyRequired
contact_numberstringRead-onlyRequired
land_linestringRead-onlyRequired
typeintegerOptional
is_login_enablebooleanOptional
avatar_colorstring | nullableOptional
is_login_activebooleanOptional
phone_numberstringRead-onlyRequired
user_idintegerOptional
departmentstring | nullableOptional
requester_typestringRead-onlyRequired
creation_timestring · date-time | nullableOptional
support_locationstring | nullableOptional
emp_typestring · max: 100Optional
notify_emailstringRead-onlyRequired
notify_phonestringRead-onlyRequired
invited_userbooleanOptional
designationstring | nullableOptional
organization_namestringRead-onlyRequired
customer_idstring · max: 255Optional
customer_entity_idstringOptional
subscriber_idstring | nullableOptional
customer_site_groupstring | nullableOptional
profile_idstring | nullableOptional
employee_idstring · max: 100Optional
contactstringRead-onlyRequired
unmasked_full_namestringRead-onlyRequired
unmasked_emailstringRead-onlyRequired
is_adbooleanOptional
is_profile_imagebooleanOptional
Responses
200Success
application/json
put
PUT /ux/common/requester/profile/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 777

{
  "requester_id": "text",
  "username": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "user_id": 1,
  "department": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
200Success
{
  "requester_id": "text",
  "full_name": "text",
  "email": "text",
  "username": "text",
  "phone_ext": "text",
  "contact_number": "text",
  "land_line": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "phone_number": "text",
  "user_id": 1,
  "department": "text",
  "requester_type": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "notify_email": "text",
  "notify_phone": "text",
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "organization_name": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "contact": "text",
  "unmasked_full_name": "text",
  "unmasked_email": "text",
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}

Deletes the requester with given id

delete

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

Authorizations
Path parameters
idstringRequired
Responses
204
No response body
delete
DELETE /ux/common/requester/profile/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

No response body

No content
post

API endpoint that allows Requester to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

requester_idstring · max: 25Required
full_namestringRead-onlyRequired
emailstringRead-onlyRequired
usernamestring | nullableOptional
phone_extstringRead-onlyRequired
contact_numberstringRead-onlyRequired
land_linestringRead-onlyRequired
typeintegerOptional
is_login_enablebooleanOptional
avatar_colorstring | nullableOptional
is_login_activebooleanOptional
phone_numberstringRead-onlyRequired
user_idintegerOptional
departmentstring | nullableOptional
requester_typestringRead-onlyRequired
creation_timestring · date-time | nullableOptional
support_locationstring | nullableOptional
emp_typestring · max: 100Optional
notify_emailstringRead-onlyRequired
notify_phonestringRead-onlyRequired
invited_userbooleanOptional
designationstring | nullableOptional
organization_namestringRead-onlyRequired
customer_idstring · max: 255Optional
customer_entity_idstringOptional
subscriber_idstring | nullableOptional
customer_site_groupstring | nullableOptional
profile_idstring | nullableOptional
employee_idstring · max: 100Optional
contactstringRead-onlyRequired
unmasked_full_namestringRead-onlyRequired
unmasked_emailstringRead-onlyRequired
is_adbooleanOptional
is_profile_imagebooleanOptional
Responses
200Success
application/json
post
POST /ux/common/requester/profile/assets/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 777

{
  "requester_id": "text",
  "username": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "user_id": 1,
  "department": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
200Success
{
  "requester_id": "text",
  "full_name": "text",
  "email": "text",
  "username": "text",
  "phone_ext": "text",
  "contact_number": "text",
  "land_line": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "phone_number": "text",
  "user_id": 1,
  "department": "text",
  "requester_type": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "notify_email": "text",
  "notify_phone": "text",
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "organization_name": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "contact": "text",
  "unmasked_full_name": "text",
  "unmasked_email": "text",
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
post

API endpoint that allows Requester to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

requester_idstring · max: 25Required
full_namestringRead-onlyRequired
emailstringRead-onlyRequired
usernamestring | nullableOptional
phone_extstringRead-onlyRequired
contact_numberstringRead-onlyRequired
land_linestringRead-onlyRequired
typeintegerOptional
is_login_enablebooleanOptional
avatar_colorstring | nullableOptional
is_login_activebooleanOptional
phone_numberstringRead-onlyRequired
user_idintegerOptional
departmentstring | nullableOptional
requester_typestringRead-onlyRequired
creation_timestring · date-time | nullableOptional
support_locationstring | nullableOptional
emp_typestring · max: 100Optional
notify_emailstringRead-onlyRequired
notify_phonestringRead-onlyRequired
invited_userbooleanOptional
designationstring | nullableOptional
organization_namestringRead-onlyRequired
customer_idstring · max: 255Optional
customer_entity_idstringOptional
subscriber_idstring | nullableOptional
customer_site_groupstring | nullableOptional
profile_idstring | nullableOptional
employee_idstring · max: 100Optional
contactstringRead-onlyRequired
unmasked_full_namestringRead-onlyRequired
unmasked_emailstringRead-onlyRequired
is_adbooleanOptional
is_profile_imagebooleanOptional
Responses
200Success
application/json
post
POST /ux/common/requester/profile/create-csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 777

{
  "requester_id": "text",
  "username": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "user_id": 1,
  "department": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
200Success
{
  "requester_id": "text",
  "full_name": "text",
  "email": "text",
  "username": "text",
  "phone_ext": "text",
  "contact_number": "text",
  "land_line": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "phone_number": "text",
  "user_id": 1,
  "department": "text",
  "requester_type": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "notify_email": "text",
  "notify_phone": "text",
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "organization_name": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "contact": "text",
  "unmasked_full_name": "text",
  "unmasked_email": "text",
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
post

API endpoint that allows Requester to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

requester_idstring · max: 25Required
full_namestringRead-onlyRequired
emailstringRead-onlyRequired
usernamestring | nullableOptional
phone_extstringRead-onlyRequired
contact_numberstringRead-onlyRequired
land_linestringRead-onlyRequired
typeintegerOptional
is_login_enablebooleanOptional
avatar_colorstring | nullableOptional
is_login_activebooleanOptional
phone_numberstringRead-onlyRequired
user_idintegerOptional
departmentstring | nullableOptional
requester_typestringRead-onlyRequired
creation_timestring · date-time | nullableOptional
support_locationstring | nullableOptional
emp_typestring · max: 100Optional
notify_emailstringRead-onlyRequired
notify_phonestringRead-onlyRequired
invited_userbooleanOptional
designationstring | nullableOptional
organization_namestringRead-onlyRequired
customer_idstring · max: 255Optional
customer_entity_idstringOptional
subscriber_idstring | nullableOptional
customer_site_groupstring | nullableOptional
profile_idstring | nullableOptional
employee_idstring · max: 100Optional
contactstringRead-onlyRequired
unmasked_full_namestringRead-onlyRequired
unmasked_emailstringRead-onlyRequired
is_adbooleanOptional
is_profile_imagebooleanOptional
Responses
200Success
application/json
post
POST /ux/common/requester/profile/create_new_requester/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 777

{
  "requester_id": "text",
  "username": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "user_id": 1,
  "department": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
200Success
{
  "requester_id": "text",
  "full_name": "text",
  "email": "text",
  "username": "text",
  "phone_ext": "text",
  "contact_number": "text",
  "land_line": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "phone_number": "text",
  "user_id": 1,
  "department": "text",
  "requester_type": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "notify_email": "text",
  "notify_phone": "text",
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "organization_name": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "contact": "text",
  "unmasked_full_name": "text",
  "unmasked_email": "text",
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
get

API endpoint that allows Requester to be viewed or edited.

Authorizations
Responses
200Success
application/json
get
GET /ux/common/requester/profile/initconfig/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "requester_id": "text",
  "full_name": "text",
  "email": "text",
  "username": "text",
  "phone_ext": "text",
  "contact_number": "text",
  "land_line": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "phone_number": "text",
  "user_id": 1,
  "department": "text",
  "requester_type": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "notify_email": "text",
  "notify_phone": "text",
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "organization_name": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "contact": "text",
  "unmasked_full_name": "text",
  "unmasked_email": "text",
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
post

API endpoint that allows Requester to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

requester_idstring · max: 25Required
full_namestringRead-onlyRequired
emailstringRead-onlyRequired
usernamestring | nullableOptional
phone_extstringRead-onlyRequired
contact_numberstringRead-onlyRequired
land_linestringRead-onlyRequired
typeintegerOptional
is_login_enablebooleanOptional
avatar_colorstring | nullableOptional
is_login_activebooleanOptional
phone_numberstringRead-onlyRequired
user_idintegerOptional
departmentstring | nullableOptional
requester_typestringRead-onlyRequired
creation_timestring · date-time | nullableOptional
support_locationstring | nullableOptional
emp_typestring · max: 100Optional
notify_emailstringRead-onlyRequired
notify_phonestringRead-onlyRequired
invited_userbooleanOptional
designationstring | nullableOptional
organization_namestringRead-onlyRequired
customer_idstring · max: 255Optional
customer_entity_idstringOptional
subscriber_idstring | nullableOptional
customer_site_groupstring | nullableOptional
profile_idstring | nullableOptional
employee_idstring · max: 100Optional
contactstringRead-onlyRequired
unmasked_full_namestringRead-onlyRequired
unmasked_emailstringRead-onlyRequired
is_adbooleanOptional
is_profile_imagebooleanOptional
Responses
200Success
application/json
post
POST /ux/common/requester/profile/requester_details/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 777

{
  "requester_id": "text",
  "username": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "user_id": 1,
  "department": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
200Success
{
  "requester_id": "text",
  "full_name": "text",
  "email": "text",
  "username": "text",
  "phone_ext": "text",
  "contact_number": "text",
  "land_line": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "phone_number": "text",
  "user_id": 1,
  "department": "text",
  "requester_type": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "notify_email": "text",
  "notify_phone": "text",
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "organization_name": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "contact": "text",
  "unmasked_full_name": "text",
  "unmasked_email": "text",
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
post

API endpoint that allows Requester to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

requester_idstring · max: 25Required
full_namestringRead-onlyRequired
emailstringRead-onlyRequired
usernamestring | nullableOptional
phone_extstringRead-onlyRequired
contact_numberstringRead-onlyRequired
land_linestringRead-onlyRequired
typeintegerOptional
is_login_enablebooleanOptional
avatar_colorstring | nullableOptional
is_login_activebooleanOptional
phone_numberstringRead-onlyRequired
user_idintegerOptional
departmentstring | nullableOptional
requester_typestringRead-onlyRequired
creation_timestring · date-time | nullableOptional
support_locationstring | nullableOptional
emp_typestring · max: 100Optional
notify_emailstringRead-onlyRequired
notify_phonestringRead-onlyRequired
invited_userbooleanOptional
designationstring | nullableOptional
organization_namestringRead-onlyRequired
customer_idstring · max: 255Optional
customer_entity_idstringOptional
subscriber_idstring | nullableOptional
customer_site_groupstring | nullableOptional
profile_idstring | nullableOptional
employee_idstring · max: 100Optional
contactstringRead-onlyRequired
unmasked_full_namestringRead-onlyRequired
unmasked_emailstringRead-onlyRequired
is_adbooleanOptional
is_profile_imagebooleanOptional
Responses
200Success
application/json
post
POST /ux/common/requester/profile/updateReportingMngr/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 777

{
  "requester_id": "text",
  "username": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "user_id": 1,
  "department": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
200Success
{
  "requester_id": "text",
  "full_name": "text",
  "email": "text",
  "username": "text",
  "phone_ext": "text",
  "contact_number": "text",
  "land_line": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "phone_number": "text",
  "user_id": 1,
  "department": "text",
  "requester_type": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "notify_email": "text",
  "notify_phone": "text",
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "organization_name": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "contact": "text",
  "unmasked_full_name": "text",
  "unmasked_email": "text",
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
post

API endpoint that allows Requester to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

requester_idstring · max: 25Required
full_namestringRead-onlyRequired
emailstringRead-onlyRequired
usernamestring | nullableOptional
phone_extstringRead-onlyRequired
contact_numberstringRead-onlyRequired
land_linestringRead-onlyRequired
typeintegerOptional
is_login_enablebooleanOptional
avatar_colorstring | nullableOptional
is_login_activebooleanOptional
phone_numberstringRead-onlyRequired
user_idintegerOptional
departmentstring | nullableOptional
requester_typestringRead-onlyRequired
creation_timestring · date-time | nullableOptional
support_locationstring | nullableOptional
emp_typestring · max: 100Optional
notify_emailstringRead-onlyRequired
notify_phonestringRead-onlyRequired
invited_userbooleanOptional
designationstring | nullableOptional
organization_namestringRead-onlyRequired
customer_idstring · max: 255Optional
customer_entity_idstringOptional
subscriber_idstring | nullableOptional
customer_site_groupstring | nullableOptional
profile_idstring | nullableOptional
employee_idstring · max: 100Optional
contactstringRead-onlyRequired
unmasked_full_namestringRead-onlyRequired
unmasked_emailstringRead-onlyRequired
is_adbooleanOptional
is_profile_imagebooleanOptional
Responses
200Success
application/json
post
POST /ux/common/requester/profile/updateRequesterStatus/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 777

{
  "requester_id": "text",
  "username": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "user_id": 1,
  "department": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
200Success
{
  "requester_id": "text",
  "full_name": "text",
  "email": "text",
  "username": "text",
  "phone_ext": "text",
  "contact_number": "text",
  "land_line": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "phone_number": "text",
  "user_id": 1,
  "department": "text",
  "requester_type": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "notify_email": "text",
  "notify_phone": "text",
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "organization_name": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "contact": "text",
  "unmasked_full_name": "text",
  "unmasked_email": "text",
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
post

API endpoint that allows Requester to be viewed or edited.

Authorizations
Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

requester_idstring · max: 25Required
full_namestringRead-onlyRequired
emailstringRead-onlyRequired
usernamestring | nullableOptional
phone_extstringRead-onlyRequired
contact_numberstringRead-onlyRequired
land_linestringRead-onlyRequired
typeintegerOptional
is_login_enablebooleanOptional
avatar_colorstring | nullableOptional
is_login_activebooleanOptional
phone_numberstringRead-onlyRequired
user_idintegerOptional
departmentstring | nullableOptional
requester_typestringRead-onlyRequired
creation_timestring · date-time | nullableOptional
support_locationstring | nullableOptional
emp_typestring · max: 100Optional
notify_emailstringRead-onlyRequired
notify_phonestringRead-onlyRequired
invited_userbooleanOptional
designationstring | nullableOptional
organization_namestringRead-onlyRequired
customer_idstring · max: 255Optional
customer_entity_idstringOptional
subscriber_idstring | nullableOptional
customer_site_groupstring | nullableOptional
profile_idstring | nullableOptional
employee_idstring · max: 100Optional
contactstringRead-onlyRequired
unmasked_full_namestringRead-onlyRequired
unmasked_emailstringRead-onlyRequired
is_adbooleanOptional
is_profile_imagebooleanOptional
Responses
200Success
application/json
post
POST /ux/common/requester/profile/upload-csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 777

{
  "requester_id": "text",
  "username": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "user_id": 1,
  "department": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
200Success
{
  "requester_id": "text",
  "full_name": "text",
  "email": "text",
  "username": "text",
  "phone_ext": "text",
  "contact_number": "text",
  "land_line": "text",
  "type": 1,
  "is_login_enable": true,
  "avatar_color": "text",
  "work_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "is_login_active": true,
  "phone_number": "text",
  "user_id": 1,
  "department": "text",
  "requester_type": "text",
  "user_details": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "creation_time": "2025-07-10T02:04:53.084Z",
  "support_location": "text",
  "emp_type": "text",
  "tags": [],
  "notify_email": "text",
  "notify_phone": "text",
  "joining_date": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "invited_user": true,
  "designation": "text",
  "organization_name": "text",
  "customer_id": "text",
  "customer_entity_id": "text",
  "subscriber_id": "text",
  "customer_site_group": "text",
  "profile_id": "text",
  "employee_id": "text",
  "base_location": {
    "keys": "text",
    "values": "text",
    "queryparam": true
  },
  "contact": "text",
  "unmasked_full_name": "text",
  "unmasked_email": "text",
  "is_ad": true,
  "subscription_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "is_profile_image": true
}
PreviousPredicted EventsNextService Feasibility Requests