Key Search

You can search for keys using a query that matches any of the following fields: name, serial number, notes, or address. If no search query is provided, the API will return all available keys.

Additionally, you can filter results by organization ID, returning all keys associated with the specified organization.

The response is returned as a JSON array containing key objects.

Example: Search by Organization ID

curl -u 'test@yourdomain.com:{password}' https://www.keycafe.com/v0/key?organization=123456 -H "Accept: application/json"

Pagination

Results are paginated, with a maximum of 50 keys per page. Additional pages can be accessed using the Link response header

Link: <https://www.keycafe.com/v0/key?query=vancouver&page=2>; rel="next",
      <https://www.keycafe.com/v0/key?query=vancouver&page=5>; rel="last"

rel="first": URL to retrieve the first page of results.
rel="prev": URL to retrieve the previous page of results.
rel="next": URL to retrieve the next page of results.
rel="last": URL to retrieve the final page of results.

200List of keys matching the search criteria.