API Registration

Gets a list of api_config profiles

get

This endpoint is used to fetch all the api_config profiles 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/apiregister/profile/?items_per_page=1&page=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "authentication_type": "text",
    "api_id": "text",
    "api_modified_id": "text",
    "name": "text",
    "api_url": "text",
    "description": "text",
    "client_id": "text",
    "app_code": "text",
    "secret_key": "text",
    "user_name": "text",
    "api_password": "text",
    "is_base64_password": true,
    "auth_key": "text",
    "auth_value": "text",
    "content_type": 1,
    "auth_type": 1,
    "add_key_to": 1,
    "token_url": "text",
    "token_prefix": "text",
    "csrf_url": "text",
    "token_key": "text",
    "token_header_key": "text",
    "token_body": "text",
    "csrf_key": "text",
    "request_type": 1,
    "user": "text",
    "header_params": [
      {
        "keys": "text",
        "values": "text",
        "queryparam": true
      }
    ],
    "api_type": 1,
    "organization": "text",
    "creation_time": "2025-06-07T18:56:41.464Z",
    "last_update_time": "2025-06-07T18:56:41.464Z",
    "is_deleted": true,
    "is_active": true,
    "is_base64": true,
    "query_param": true,
    "is_sandbox": true,
    "sandbox_url": "text",
    "is_webhook_enabled": true
  }
]

Creates a new API configuration

post

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

Authorizations

Body

Other propertiesanyOptional

Responses

201

No response body

post

HTTPcURLJavaScriptPython

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

{
  "headerParamList": [
    {
      "keys": "sort",
      "values": "name"
    },
    {
      "keys": "reverse",
      "values": "-"
    }
  ],
  "name": "API Auth",
  "content_type": 1,
  "authentication_type": "Basic Auth",
  "user_name": "shilpa.v",
  "password": "hanTZ123$",
  "api_url": "http://test-api-auth.com",
  "description": "Test API Auth",
  "enc_password": "ZDk5NjMwYmNjNzA1ODYzOWU3ZTgwZGYyMzlmMzhhMzI6OlUyRnNkR1ZrWDE5ZGJ5YUp3azBHT01OZ2dwVldQUFVlaEhmOVE2SVBreWs9"
}

201

No response body

No content

Gets a api_config with the given id

get

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

Authorizations

Path parameters

idstringRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "text",
  "authentication_type": "text",
  "api_id": "text",
  "api_modified_id": "text",
  "name": "text",
  "api_url": "text",
  "description": "text",
  "client_id": "text",
  "app_code": "text",
  "secret_key": "text",
  "user_name": "text",
  "api_password": "text",
  "is_base64_password": true,
  "auth_key": "text",
  "auth_value": "text",
  "content_type": 1,
  "auth_type": 1,
  "add_key_to": 1,
  "token_url": "text",
  "token_prefix": "text",
  "csrf_url": "text",
  "token_key": "text",
  "token_header_key": "text",
  "token_body": "text",
  "csrf_key": "text",
  "request_type": 1,
  "user": "text",
  "header_params": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "api_type": 1,
  "organization": "text",
  "creation_time": "2025-06-07T18:56:41.464Z",
  "last_update_time": "2025-06-07T18:56:41.464Z",
  "is_deleted": true,
  "is_active": true,
  "is_base64": true,
  "query_param": true,
  "is_sandbox": true,
  "sandbox_url": "text",
  "is_webhook_enabled": true
}

Edits the api_config with given id

put

This endpoint is used to edit an existing api_config 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

authentication_typestringRead-onlyRequired

api_idstring · max: 225Required

api_modified_idstring | nullableOptional

namestring · max: 225Optional

api_urlstringOptional

descriptionstringOptional

client_idstringOptional

app_codestringOptional

secret_keystringOptional

user_namestringOptional

api_passwordstringOptional

is_base64_passwordbooleanOptional

auth_keystringOptional

auth_valuestringOptional

content_typeintegerOptional

auth_typeintegerOptional

add_key_tointegerOptional

token_urlstringOptional

token_prefixstringOptional

csrf_urlstringOptional

token_keystringOptional

token_header_keystringOptional

token_bodystringOptional

csrf_keystringOptional

request_typeintegerOptional

userstringOptional

api_typeintegerOptional

organizationstring · max: 225Required

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

is_deletedbooleanOptional

is_activebooleanOptional

is_base64booleanOptional

query_parambooleanOptional

is_sandboxbooleanOptional

sandbox_urlstringOptional

is_webhook_enabledbooleanOptional

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

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

{
  "api_id": "text",
  "api_modified_id": "text",
  "name": "text",
  "api_url": "text",
  "description": "text",
  "client_id": "text",
  "app_code": "text",
  "secret_key": "text",
  "user_name": "text",
  "api_password": "text",
  "is_base64_password": true,
  "auth_key": "text",
  "auth_value": "text",
  "content_type": 1,
  "auth_type": 1,
  "add_key_to": 1,
  "token_url": "text",
  "token_prefix": "text",
  "csrf_url": "text",
  "token_key": "text",
  "token_header_key": "text",
  "token_body": "text",
  "csrf_key": "text",
  "request_type": 1,
  "user": "text",
  "header_params": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "api_type": 1,
  "organization": "text",
  "creation_time": "2025-06-07T18:56:41.464Z",
  "last_update_time": "2025-06-07T18:56:41.464Z",
  "is_deleted": true,
  "is_active": true,
  "is_base64": true,
  "query_param": true,
  "is_sandbox": true,
  "sandbox_url": "text",
  "is_webhook_enabled": true
}

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

200Success

{
  "id": "text",
  "authentication_type": "text",
  "api_id": "text",
  "api_modified_id": "text",
  "name": "text",
  "api_url": "text",
  "description": "text",
  "client_id": "text",
  "app_code": "text",
  "secret_key": "text",
  "user_name": "text",
  "api_password": "text",
  "is_base64_password": true,
  "auth_key": "text",
  "auth_value": "text",
  "content_type": 1,
  "auth_type": 1,
  "add_key_to": 1,
  "token_url": "text",
  "token_prefix": "text",
  "csrf_url": "text",
  "token_key": "text",
  "token_header_key": "text",
  "token_body": "text",
  "csrf_key": "text",
  "request_type": 1,
  "user": "text",
  "header_params": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "api_type": 1,
  "organization": "text",
  "creation_time": "2025-06-07T18:56:41.464Z",
  "last_update_time": "2025-06-07T18:56:41.464Z",
  "is_deleted": true,
  "is_active": true,
  "is_base64": true,
  "query_param": true,
  "is_sandbox": true,
  "sandbox_url": "text",
  "is_webhook_enabled": true
}

Deletes the api_config with given id

delete

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

Authorizations

Path parameters

idstringRequired

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

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

204

No response body

No content

get

API endpoint that allows API's to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/common/apiregister/profile/allapi-list/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "authentication_type": "text",
  "api_id": "text",
  "api_modified_id": "text",
  "name": "text",
  "api_url": "text",
  "description": "text",
  "client_id": "text",
  "app_code": "text",
  "secret_key": "text",
  "user_name": "text",
  "api_password": "text",
  "is_base64_password": true,
  "auth_key": "text",
  "auth_value": "text",
  "content_type": 1,
  "auth_type": 1,
  "add_key_to": 1,
  "token_url": "text",
  "token_prefix": "text",
  "csrf_url": "text",
  "token_key": "text",
  "token_header_key": "text",
  "token_body": "text",
  "csrf_key": "text",
  "request_type": 1,
  "user": "text",
  "header_params": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "api_type": 1,
  "organization": "text",
  "creation_time": "2025-06-07T18:56:41.464Z",
  "last_update_time": "2025-06-07T18:56:41.464Z",
  "is_deleted": true,
  "is_active": true,
  "is_base64": true,
  "query_param": true,
  "is_sandbox": true,
  "sandbox_url": "text",
  "is_webhook_enabled": true
}

get

API endpoint that allows API's to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /ux/common/apiregister/profile/api_search/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "authentication_type": "text",
  "api_id": "text",
  "api_modified_id": "text",
  "name": "text",
  "api_url": "text",
  "description": "text",
  "client_id": "text",
  "app_code": "text",
  "secret_key": "text",
  "user_name": "text",
  "api_password": "text",
  "is_base64_password": true,
  "auth_key": "text",
  "auth_value": "text",
  "content_type": 1,
  "auth_type": 1,
  "add_key_to": 1,
  "token_url": "text",
  "token_prefix": "text",
  "csrf_url": "text",
  "token_key": "text",
  "token_header_key": "text",
  "token_body": "text",
  "csrf_key": "text",
  "request_type": 1,
  "user": "text",
  "header_params": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "api_type": 1,
  "organization": "text",
  "creation_time": "2025-06-07T18:56:41.464Z",
  "last_update_time": "2025-06-07T18:56:41.464Z",
  "is_deleted": true,
  "is_active": true,
  "is_base64": true,
  "query_param": true,
  "is_sandbox": true,
  "sandbox_url": "text",
  "is_webhook_enabled": true
}

get

API endpoint that allows API's to be viewed or edited.

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

{
  "id": "text",
  "authentication_type": "text",
  "api_id": "text",
  "api_modified_id": "text",
  "name": "text",
  "api_url": "text",
  "description": "text",
  "client_id": "text",
  "app_code": "text",
  "secret_key": "text",
  "user_name": "text",
  "api_password": "text",
  "is_base64_password": true,
  "auth_key": "text",
  "auth_value": "text",
  "content_type": 1,
  "auth_type": 1,
  "add_key_to": 1,
  "token_url": "text",
  "token_prefix": "text",
  "csrf_url": "text",
  "token_key": "text",
  "token_header_key": "text",
  "token_body": "text",
  "csrf_key": "text",
  "request_type": 1,
  "user": "text",
  "header_params": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "api_type": 1,
  "organization": "text",
  "creation_time": "2025-06-07T18:56:41.464Z",
  "last_update_time": "2025-06-07T18:56:41.464Z",
  "is_deleted": true,
  "is_active": true,
  "is_base64": true,
  "query_param": true,
  "is_sandbox": true,
  "sandbox_url": "text",
  "is_webhook_enabled": true
}

post

API endpoint that allows API's to be viewed or edited.

Authorizations

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

authentication_typestringRead-onlyRequired

api_idstring · max: 225Required

api_modified_idstring | nullableOptional

namestring · max: 225Optional

api_urlstringOptional

descriptionstringOptional

client_idstringOptional

app_codestringOptional

secret_keystringOptional

user_namestringOptional

api_passwordstringOptional

is_base64_passwordbooleanOptional

auth_keystringOptional

auth_valuestringOptional

content_typeintegerOptional

auth_typeintegerOptional

add_key_tointegerOptional

token_urlstringOptional

token_prefixstringOptional

csrf_urlstringOptional

token_keystringOptional

token_header_keystringOptional

token_bodystringOptional

csrf_keystringOptional

request_typeintegerOptional

userstringOptional

api_typeintegerOptional

organizationstring · max: 225Required

creation_timestring · date-timeOptional

last_update_timestring · date-timeOptional

is_deletedbooleanOptional

is_activebooleanOptional

is_base64booleanOptional

query_parambooleanOptional

is_sandboxbooleanOptional

sandbox_urlstringOptional

is_webhook_enabledbooleanOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /ux/common/apiregister/profile/verify_api/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 803

{
  "api_id": "text",
  "api_modified_id": "text",
  "name": "text",
  "api_url": "text",
  "description": "text",
  "client_id": "text",
  "app_code": "text",
  "secret_key": "text",
  "user_name": "text",
  "api_password": "text",
  "is_base64_password": true,
  "auth_key": "text",
  "auth_value": "text",
  "content_type": 1,
  "auth_type": 1,
  "add_key_to": 1,
  "token_url": "text",
  "token_prefix": "text",
  "csrf_url": "text",
  "token_key": "text",
  "token_header_key": "text",
  "token_body": "text",
  "csrf_key": "text",
  "request_type": 1,
  "user": "text",
  "header_params": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "api_type": 1,
  "organization": "text",
  "creation_time": "2025-06-07T18:56:41.464Z",
  "last_update_time": "2025-06-07T18:56:41.464Z",
  "is_deleted": true,
  "is_active": true,
  "is_base64": true,
  "query_param": true,
  "is_sandbox": true,
  "sandbox_url": "text",
  "is_webhook_enabled": true
}

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

200Success

{
  "id": "text",
  "authentication_type": "text",
  "api_id": "text",
  "api_modified_id": "text",
  "name": "text",
  "api_url": "text",
  "description": "text",
  "client_id": "text",
  "app_code": "text",
  "secret_key": "text",
  "user_name": "text",
  "api_password": "text",
  "is_base64_password": true,
  "auth_key": "text",
  "auth_value": "text",
  "content_type": 1,
  "auth_type": 1,
  "add_key_to": 1,
  "token_url": "text",
  "token_prefix": "text",
  "csrf_url": "text",
  "token_key": "text",
  "token_header_key": "text",
  "token_body": "text",
  "csrf_key": "text",
  "request_type": 1,
  "user": "text",
  "header_params": [
    {
      "keys": "text",
      "values": "text",
      "queryparam": true
    }
  ],
  "api_type": 1,
  "organization": "text",
  "creation_time": "2025-06-07T18:56:41.464Z",
  "last_update_time": "2025-06-07T18:56:41.464Z",
  "is_deleted": true,
  "is_active": true,
  "is_base64": true,
  "query_param": true,
  "is_sandbox": true,
  "sandbox_url": "text",
  "is_webhook_enabled": true
}