Search Alias Codes

Retrieve data for multiple alias codes with a GET request to the endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

If no search parameters are specified, the API will return all alias codes.

Pagination

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

Example

Link: <https://www.keycafe.com/v0/aliasCode?location=123456&page=2>; rel="next", <https://www.keycafe.com/v0/aliasCode?location=123456&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.
Query Params
string

Alias code string used for key access.
Example: 123456

int64

Access record linked to the alias code.

int64

The ID of the location where the action or event occurred.
Example: 123456

Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json