API Basics

Welcome to the Incipulse API. This guide covers the fundamental conventions and standards used across our API reference.

Base URL

All API requests should be made to the following base URL:

https://stg.itechops.com/api

[!NOTE] Some endpoints may have specific prefixes like /admin. Always refer to the endpoint documentation for the full path.

We use standard HTTP verbs to indicate the type of action being performed:

Verb	Description
GET	Retrieve a resource or a list of resources.
POST	Create a new resource or perform a complex action (like search).
PUT	Update an existing resource (full replacement).
PATCH	Update specific fields of a resource (partial update).
DELETE	Remove a resource.

All POST, PUT, and PATCH requests expect data in JSON format. You must include the following header:

Content-Type: application/json

Most success responses are wrapped in a standard ApiResponse<T> structure:

{
  "Success": true,
  "Result": { ... },
  "Message": "Success"
}

In case of errors (400, 401, 500, etc.), the API returns a clear message:

{
  "Success": false,
  "Result": null,
  "Message": "Error details here"
}

All dates are returned in ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ.