Filtering

✨

Supported Endpoints

Filtering is supported for the GET /jobs, GET /candidates, and GET /applications endpoints. Ensure you use the correct parameters to avoid unnecessary data processing.

Filtering Parameters

The following parameters can be used to filter results across different endpoints:

GET /jobs

GET /applications

GET /companies

Explanation of Filter Types:

• Exact match: The filter will return results that match the parameter value exactly.
• Contains (case-insensitive): The filter matches partial values, regardless of case (e.g., title=developer will match "Software Developer").
• Greater than or equal: Filters results where the value is greater than or equal to the provided value, typically used with date fields.

Example Requests

1. Filter Jobs by Status and Location
   Retrieve all active jobs located in Berlin:

   GET /jobs?status=active&location=Berlin

2. Filter Candidates by Creation Date
   Retrieve candidates created after January 1, 2024:
   Text

   GET /candidates?created_at=2024-01-01

Response Format

Filtered requests return the same response format as paginated requests, with metadata fields like count, next, and previous. The results array will contain only entries matching the specified filters.

Example Response

{
  "count": 125,
  "next": "https://api.getkini.com/jobs?status=active&page=1&limit=20",
  "previous": null,
  "results": [
    {
      "id": 42,
      "title": "Software Developer",
      "status": "active"
    },
    {
      "id": 43,
      "title": "Data Scientist",
      "status": "active"
    }
  ]
}

Best Practices

1. Combine Filtering with Pagination
   Use filters together with pagination to efficiently navigate large datasets while retrieving only relevant data.

   Example:

   Text

   GET /jobs?status=active&location=Berlin&page=1&limit=20

2. Validate Filter Parameters
   Ensure your filter parameters are valid for the specified endpoint. Invalid filters will be ignored by the API.

3. Use Date Filters Wisely
   When using date filters like created_at, ensure you format the date correctly to avoid errors.