Using the API

Once you have the authentication token from Setting Up the API, you're ready to interact with the API. Here are some key points to remember:

• The base URL for all API requests is: https://app.kinabase.com/api/v1/
• All requests must include the following headers:

{  
    "Content-Type": "application/json",  
    "Accept": "application/json",  
    "Authorization": "Bearer {your-token-here}"  
}

• The request body should always be a valid JSON object.

Example Request

Here’s a sample API request to retrieve records from a collection, in Javascript:

fetch (""https://app.kinabase.com/api/v1/collections"", {  
      method: ‘get’,  
      headers: {  
          'Content-Type': 'application/json',  
          'Accept': 'application/json',  
          'Authorization' : `Bearer ${yourTokenHere}`',  
      },  
})  

Example of a successful response:

{  
  "records": [  
    {  
      "data": {  
         ...
      } 
    }
    ],  
  "totalRecords": 1,  
  "pageIndex": 0,  
  "pageSize": 10  
}  

Troubleshooting

Here are some common issues you may encounter when using the Kinabase API, along with suggested solutions:

• Incorrect Field Naming: Ensure that field names are in camelCase. For example, “Job Title” should be passed as jobTitle.
• Case Sensitivity: Field names are case-sensitive. If you use Name instead of name, the request will fail with a 400 Bad Request.
• Collection ID: Some requests require a collection ID. You can retrieve it by making a GET request to /collections and searching for the id property, or by using the collection's slug (e.g., purchase-orders).

For further assistance, please contact our support team by emailing support@kinabase.com or calling (+44) 1223 626261.