Partner
This endpoint is used to fetch all the partners in the current organization
Items Per Page
Page Number
Sorting Order
Sorting Key
GET /ux/common/partner/partner/?items_per_page=1&page=1 HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": "text",
"profile_image": "text",
"partner_id": "text",
"organization": "text",
"partner_name": "text",
"email": "text",
"contact_number": "text",
"password": "text",
"phone": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"address": "text",
"partner_operators": [],
"avatar_color": "text",
"group_id": 1,
"profile_id": "text",
"user_id": 1,
"created_by": 1,
"modified_by": 1,
"creation_time": "2025-08-31T09:29:04.605Z",
"last_update_time": "2025-08-31T09:29:04.605Z",
"is_deleted": true
}
]This endpoint is used to save a new partner for the current organization
No response body
No content
POST /ux/common/partner/partner/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"partner_name": "Sadaf",
"business_email": "[email protected]",
"phone": "7411556607",
"address": "zxcvbnm"
}No response body
No content
This endpoint is used to fetch a partner details in the current organization
GET /ux/common/partner/partner/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"profile_image": "text",
"partner_id": "text",
"organization": "text",
"partner_name": "text",
"email": "text",
"contact_number": "text",
"password": "text",
"phone": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"address": "text",
"partner_operators": [],
"avatar_color": "text",
"group_id": 1,
"profile_id": "text",
"user_id": 1,
"created_by": 1,
"modified_by": 1,
"creation_time": "2025-08-31T09:29:04.605Z",
"last_update_time": "2025-08-31T09:29:04.605Z",
"is_deleted": true
}This endpoint is used to edit an existing partner for the current organization
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.
PUT /ux/common/partner/partner/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 414
{
"partner_id": "text",
"organization": "text",
"partner_name": "text",
"email": "text",
"contact_number": "text",
"password": "text",
"phone": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"address": "text",
"partner_operators": [],
"avatar_color": "text",
"group_id": 1,
"profile_id": "text",
"user_id": 1,
"created_by": 1,
"modified_by": 1,
"creation_time": "2025-08-31T09:29:04.605Z",
"last_update_time": "2025-08-31T09:29:04.605Z",
"is_deleted": true
}{
"id": "text",
"profile_image": "text",
"partner_id": "text",
"organization": "text",
"partner_name": "text",
"email": "text",
"contact_number": "text",
"password": "text",
"phone": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"address": "text",
"partner_operators": [],
"avatar_color": "text",
"group_id": 1,
"profile_id": "text",
"user_id": 1,
"created_by": 1,
"modified_by": 1,
"creation_time": "2025-08-31T09:29:04.605Z",
"last_update_time": "2025-08-31T09:29:04.605Z",
"is_deleted": true
}This endpoint is used to delete an existing partner for the current organization
No response body
No content
DELETE /ux/common/partner/partner/{id}/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No response body
No content
API endpoint that allows users to be viewed or edited.
GET /ux/common/partner/partner/filter/ HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"profile_image": "text",
"partner_id": "text",
"organization": "text",
"partner_name": "text",
"email": "text",
"contact_number": "text",
"password": "text",
"phone": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"address": "text",
"partner_operators": [],
"avatar_color": "text",
"group_id": 1,
"profile_id": "text",
"user_id": 1,
"created_by": 1,
"modified_by": 1,
"creation_time": "2025-08-31T09:29:04.605Z",
"last_update_time": "2025-08-31T09:29:04.605Z",
"is_deleted": true
}