API Response Structure

Success Message

Knit API's response will always have success body parameter set. success boolean can be used for evaluating whether an API call was successful. A successful API call will also contain dataobject. The API response will be present within data object. Below is an example for successful Employee Location API response

All responses from Knit's API share a consistent top-level structure:

Successful Response

When a request succeeds, success is true and the response payload is nested inside the data object. The shape of data varies by endpoint.

Example - generic structure:

{
  "success": true,
  "data": {
    
  }
}

Example - Employee Location endpoint:

{
  "success": true,
  "data": {
    "employeeId": "emp_8a7f3k",
    "addressLine1": "221B Baker Street",
    "addressLine2": "Apt 2",
    "city": "London",
    "state": "England",
    "country": "GB",
    "zipCode": "NW1 6XE",
    "addressType": "HOME_PRESENT"
  }
}

Error Message

When a request fails, success is false and the error object contains details about what went wrong.

{
  "success": false,
  "error": {
    "msg": "No such employee exists"
  }
}

Tip: Always check the success field first before processing the data object to avoid runtime errors on failed responses.

Response Headers

Below is a set of Knit headers you can expect in the API Response