Metadata - Endole API

Every successful API response includes a meta block alongside your requested data. The metadata provides contextual information about the API request such as execution timestamps, authentication details, request identifiers, and remaining credit balances.

Example Payload

{
  "status": "success",
  "company_number": "00445790",
  "data": {},
  "meta": {
    "api_key": "1591e4...23c1ce",
    "api_key_name": "My API Key",
    "request_id": "1464819",
    "request_path": "/company/12345678/vat",
    "timestamp": "2026-09-18T18:22:54+01:00",
    "credits": {
      "cost": 5,
      "remaining": 971
    }
  }
}

Reference

Field	Description
api_key	A masked version of the API key used to make the request.
api_key_name	The memorable name assigned to your API key in the dashboard.
request_id	A unique identifier for the specific API request. Quote this ID when contacting support regarding a specific query.
request_path	The exact endpoint path that was executed.
timestamp	The ISO 8601 formatted date and time when the request was processed.
credits.cost	The total number of API credits deducted for this request.
credits.remaining	The balance of credits available in your account after deducting the request cost.