Skip to content

Admin Panel APIs (1.0.0)

The Admin Panel APIs provide endpoints for managing organizations, users, roles, system configurations, and security features. They also support timestamp-based access controls and geo-fencing to enhance security and compliance.

Download OpenAPI description
Languages
Servers
Mock server
https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/
Production server
https://api.ivalt.com/admin/public/api/

Admin Panel Apis

Admin Panel APIs for organization, user, and role management. Includes system configurations, security controls, timestamps, and geo-fencing features.

Operations

Delete Geo Fencing of Organization

Request

Delete a geo fence by ID from the organization

Security
ApiKeyAuth
Path
org_idintegerrequired

Org Id provided via path.

Example: 32
idintegerrequired

Id provided via path.

Example: 32
curl -i -X DELETE \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/32/delete/geo-fence/32 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Geo fence deleted successfully

Bodyapplication/json
statusstringrequired

Outcome of the request. Always success for 2xx responses.

Value"success"
Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{ "status": "success", "message": "Delete Geo Fencing of Organization" }

Update Geo Fencing of Organization

Request

Update details of a specific geo fence

Security
ApiKeyAuth
Path
idintegerrequired

Id provided via path.

Example: 2
org_idintegerrequired

Org Id provided via path.

Example: 32
Bodyapplication/jsonrequired

Request payload for geo-fence PUT.

namestringrequired

Name of put /organization/{org_id}/update/geo-fence/{id} request.

Example: "Amritsar Main Office"
latitudenumberrequired

Latitude of put /organization/{org_id}/update/geo-fence/{id} request.

Example: 31.634
longitudenumberrequired

Longitude of put /organization/{org_id}/update/geo-fence/{id} request.

Example: 74.8723
radiusintegerrequired

Radius of put /organization/{org_id}/update/geo-fence/{id} request.

Example: 75
is_activeintegerrequired

Is active of put /organization/{org_id}/update/geo-fence/{id} request.

Example: 1
curl -i -X PUT \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/32/update/geo-fence/2 \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Amritsar Main Office",
    "latitude": 31.634,
    "longitude": 74.8723,
    "radius": 75,
    "is_active": 1
  }'

Responses

Geo fence updated successfully

Bodyapplication/json
statusstringrequired

Outcome of the request. Always success for 2xx responses.

Value"success"
Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{ "status": "success", "message": "Update Geo Fencing of Organization" }

Get Organization Timeslots

Request

Retrieve timeslots for an organization

Security
ApiKeyAuth
Path
org_idintegerrequired

Organization ID

Example: 32
curl -i -X GET \
  https://api-docs.ivalt.com/_mock/products/admin-portal/admin_apis/organization/32/timeslots \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json
statusstringrequired

Outcome of the request. Always success for 2xx responses.

Value"success"
Example: "success"
messagestringrequired

Short description of the successful operation outcome.

Example: "Operation completed successfully"
Response
application/json
{ "status": "success", "message": "Operation completed successfully" }