Searching Access Records

You can search for access records using a variety of fields. The query can match:

• Guest information: name, email, or mobile number
• Key details: name, serial number, notes, or address

If no search query is provided, the API will return all access records. Results are returned as a JSON array containing Access objects.

Filter by Key ID

You can search for accesses associated with a specific key. This will return all ongoing or future accesses for the specified key.

curl -u '[email protected]:{password}' \
  https://www.keycafe.com/v0/access?key=123456 \
  -H "Accept: application/json"

Filter by User ID

You can also filter by user ID to retrieve all ongoing or future accesses assigned to a specific user.

curl -u '[email protected]:{password}' \
  https://www.keycafe.com/v0/access?user=123456 \
  -H "Accept: application/json"

Filter by Organization ID

To retrieve all accesses created for keys belonging to a specific organization, you can search by organization ID.

curl -u '[email protected]:{password}' \
  https://www.keycafe.com/v0/access?organization=123456 \
  -H "Accept: application/json"

Pagination

Search results are paginated with 50 results per page. Use the Link response header to access additional pages:

Link: <https://www.keycafe.com/v0/access?query=bob&page=2>; rel="next",
      <https://www.keycafe.com/v0/access?query=bob&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.