Getting started

Make your first Activity request using OAuth 2.0 client credentials. This authenticates your organization’s application, not a resident.

1. Receive your credentials

Ask Easy Entry for your client ID, client secret and assigned facility ID. Store the secret in your backend’s secret manager. Never put it in a mobile app, browser code or shared Postman collection.

2. Request an access token

POST https://auth.easyentry.app/oauth2/token

Use HTTP Basic authentication: the username is your client ID and the password is your client secret.

Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials

scope=easy-entry-api/activity.read

The response contains access_token, token_type and expires_in. Cache the token until shortly before its expiry; request a new one when needed. Client credentials does not issue a refresh token.

3. Call Activity

GET https://api.easyentry.app/partners/facilities/{facilityId}/activities?PageSize=10&CurrentPage=1

Replace {facilityId} with the location assigned by Easy Entry. Send Authorization: Bearer {access_token}. No APIM subscription key or environment header is required.

Use the API reference for supported filters and the response schema. Increment CurrentPage to retrieve subsequent pages.

Try it in Postman

Open your Activity request → Authorization → OAuth 2.0 → Configure New Token. Select Client Credentials. Set Access Token URL to https://auth.easyentry.app/oauth2/token, enter your client ID and client secret, and set Scope to easy-entry-api/activity.read. Choose Send as Basic Auth header for client authentication.

Click Get New Access Token, then Use Token. Keep Header Prefix as Bearer and add authorization to Request Headers. Send the Activity request. Keep Share Token off.

Location and data access

Each application is mapped to its assigned location. Activity visibility matches a facility administrator at that location; this is not resident-specific authorization. Your backend must decide which of your own users can view the returned data. A token cannot be used to select an unrelated community.

Limits and errors

Requests are limited to 60 per minute per client. For 429 responses, honor Retry-After and retry later. Avoid repeatedly requesting a token for every API call.

401 — Check the bearer token, expiry and requested scope. 403 — Contact Easy Entry to check your application mapping and assigned location. 400 — Check your request parameters. 404 — Check that the route is exposed by the Partner API.

If a client secret is exposed, contact Easy Entry to replace the credentials. Never send secrets in support messages.

Easy Entry · Partner API documentation