Making API Requests

All REGOS API methods are called with POST. Use the endpoint created for a local or catalog integration.

Learn how to get an endpoint.

Methods marked as Deprecated are not updated or supported. Their behavior is kept only for compatibility and is not guaranteed to be improved.

Each request must include the required headers:

Name	Required	Value
Content-Type	Required	application/json;charset=utf-8

At the application level, REGOS API uses the HTTP 200 response contract. Business errors are returned as ErrorResult inside result. Other HTTP status codes usually come from external infrastructure, a gateway, or an unavailable server before the request reaches the API layer.

Response Body

Name	Type	Required	Description
ok	Boolean	Required	Indicates whether the request completed successfully.
result	Object or array of objects	Required	Response payload. The payload can be a single object or an array, depending on the method.

Successful object response

{
  "ok": true,
  "result": {
    "new_id": 1
  }
}

Successful bulk-change response

{
  "ok": true,
  "result": {
    "row_affected": 2,
    "ids": [
      1016537,
      1016538
    ]
  }
}

For methods that perform bulk changes, the standard successful response contains both row_affected and ids, where ids contains the records that were actually changed.
Legacy methods that still return only row_affected are treated as a temporary compatibility limitation until the contract is unified.

Successful array response

{
  "ok": true,
  "result": [
    {
      "id": 1,
      "name": "green",
      "last_update": 1534151629
    }
  ]
}

Error response

{
  "ok": false,
  "result": {
    "error": 9000,
    "description": "Authorization error. Token header is missing."
  }
}

See the full error list.