Skip to content

GET /status

Returns the health status of your current API session, along with version information and any recent errors.

Request

GET /api/{account}/v4.0.0/status
Authorization: Bearer <xa-token>

Parameters

Name In Type Required Description
nonce query integer (int64) No Client-generated unique sequential number

Responses

200 — Status returned

Returns a statusResponse object:

{
  "status": "ready - login: john, company: Demo Westix DEMO",
  "server_time": "2024-11-15T10:30:00Z",
  "versions": {
    "called_api_version": "v4.0.0",
    "current_api_version": "v4.0.1"
  },
  "errors": []
}
Field Type Description
status string Human-readable session/health summary
server_time string (date-time) Server time when status was generated (ISO 8601)
versions object API version comparison — see below
errors array Recent errors in this session context (may be empty)

versions object

Field Type Description
called_api_version string API version inferred from the request URL
current_api_version string Current API version active on the server

Tip

If called_api_version differs from current_api_version, consider updating your base URL to use the latest version.

errors array

Each item in errors is an apiError object with fields: code, message, timestamp, and optionally path and request_id.

403 — Access denied

The session token is invalid or has expired. Re-authenticate via GET /helo.

Example

curl -X GET \
  "https://gestix.pt:443/api/03101176/v4.0.0/status" \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN"

import requests

response = requests.get(
    "https://gestix.pt:443/api/03101176/v4.0.0/status",
    headers={"Authorization": "Bearer YOUR_SESSION_TOKEN"}
)
data = response.json()
print(data["status"])