API Documentation

Interactive API documentation and explorer

Endpoints

40 endpoints

Standard Response Format

All API endpoints return responses in a consistent format with asuccessflag and eitherdataorerrorobjects.

Success Response

Successful responses include asuccess: trueflag and adataobject containing the result.

{
  "success": true,
  "data": {
    "_id": "507f1f77bcf86cd799439011",
    "apiName": "contact",
    "displayName": "Contact",
    "activeVersion": 2,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T14:45:00.000Z"
  }
}

HTTP Status: 200 OK (or 201 Created for POST requests)

Error Response

Error responses include asuccess: falseflag and anerrorobject with a code, message, and optional details.

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid input",
    "details": [
      "apiName is required and must be a string",
      "displayName must be a non-empty string"
    ]
  }
}

HTTP Status: 400 Bad Request, 404 Not Found, 409 Conflict, 500 Internal Server Error, etc.

Common Error Codes

VALIDATION_ERRORRequest validation failed (400)

NOT_FOUNDResource not found (404)

CONFLICTResource conflict, e.g., optimistic locking failure (409)

DUPLICATEDuplicate resource (409)

UNAUTHORIZEDMissing or invalid API key (401)

INTERNAL_ERRORInternal server error (500)

Authentication

Endpoints under/api/integration/*require API key authentication. Include your API key in theX-API-Keyheader.

X-API-Key: your-api-key-here

Manage API keys via the/api/api-keysendpoints.