# Responses

## 🧾 Standard Response Structure

All NX API endpoints return a **standardized top-level response object**.

This structure applies consistently, regardless of the type of record returned (e.g., Employees, Checks, TimeCards, etc.).

### Example

```json
{
  "records": [ /* array of records */ ],
  "length": 10,
  "status": "SUCCESS",
  "count": 125,
  "duration": 0.284,
  "serverRequestTimestamp": "2025-11-02T16:55:51.920Z",
  "serverResponseTimestamp": "2025-11-02T16:55:52.204Z",
  "serverClientDrift": 0
}

```

### Top-Level Fields

| Field                     | Type                  | Description                                                                               |
| ------------------------- | --------------------- | ----------------------------------------------------------------------------------------- |
| `records`                 | array                 | The collection of returned objects. Each object follows its entity-specific schema.       |
| `length`                  | integer               | Number of records returned in the current response.                                       |
| `status`                  | string                | Indicates request success or failure (e.g., `"SUCCESS"`, `"ERROR"`).                      |
| `count`                   | integer               | Total number of records matching the query (may exceed `length` if paginated).            |
| `duration`                | number                | Total time in seconds taken to process the request.                                       |
| `serverRequestTimestamp`  | string (ISO 8601 UTC) | Timestamp when the NX API received the request.                                           |
| `serverResponseTimestamp` | string (ISO 8601 UTC) | Timestamp when the NX API completed the response.                                         |
| `serverClientDrift`       | number                | Time difference, in seconds, between the client’s reported clock and the NX server clock. |