Partner

Gets a list of partners

get

This endpoint is used to fetch all the partners in the current organization

Authorizations

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

[
  {
    "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-06-07T19:57:02.324Z",
    "last_update_time": "2025-06-07T19:57:02.324Z",
    "is_deleted": true
  }
]

Creates a new partner

post

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

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

post

HTTPcURLJavaScriptPython

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": "[e-mail]",
  "phone": "7411556607",
  "address": "zxcvbnm"
}

201

No response body

No content

Gets a partner with the given id

get

This endpoint is used to fetch a partner details in the current organization

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

{
  "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-06-07T19:57:02.324Z",
  "last_update_time": "2025-06-07T19:57:02.324Z",
  "is_deleted": true
}

Edits the partner with given id

put

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

Authorizations

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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.

idstringRead-onlyRequired

profile_imagestringRead-onlyRequired

partner_idstring · max: 25Required

organizationstring · max: 25Required

partner_namestring · max: 255Required

emailstring · max: 255Required

contact_numberstring | nullableOptional

passwordstringOptional

addressstring · max: 200Optional

avatar_colorstring | nullableOptional

group_idintegerOptional

profile_idstring | nullableOptional

user_idintegerOptional

created_byintegerOptional

modified_byintegerOptional

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

is_deletedbooleanOptional

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

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-06-07T19:57:02.324Z",
  "last_update_time": "2025-06-07T19:57:02.324Z",
  "is_deleted": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "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-06-07T19:57:02.324Z",
  "last_update_time": "2025-06-07T19:57:02.324Z",
  "is_deleted": true
}

Deletes the partner with given id

delete

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

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

DELETE /ux/common/partner/partner/{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

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/common/partner/partner/filter/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "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-06-07T19:57:02.324Z",
  "last_update_time": "2025-06-07T19:57:02.324Z",
  "is_deleted": true
}