The eyworks Public API provides secure, authenticated access to selected nursery data for customer integrations, reporting, business intelligence tools and other connected applications.

This guide explains what you need before starting, how to request access, and how to make your first API request. For the complete endpoint reference, including request and response examples, visit the eyworks Public API Postman documentation.

What you need before you start

API credentials are issued for your tenant and are limited to the nurseries and permissions covered by your licence.

Request API access

Once your API licence is active, the eyworks support team can generate your tenant-specific clientId and clientSecret.

Your API address

Your API address is based on your eyworks tenant:

https://<your-tenant-subdomain>.eylog.co.uk/public/v1

Replace <your-tenant-subdomain> with the subdomain supplied for your eyworks account.

Try the API with Postman

Postman lets you review and try the API before building it into your own system.

Run the collection in Postman

Open the eyworks Public API Postman documentation to view the available endpoints, request details and response examples.

You can fork or import the collection into your own Postman workspace, then enter your tenant-specific values locally before making requests.

The collection does not include customer credentials or a shared environment. Set your own baseUrl, clientId and clientSecret locally.

Get an access token

The API uses an OAuth 2.0-style client credentials flow with bearer access tokens. Use the client credentials supplied by eyworks to request an access token:

POST https://<your-tenant-subdomain>.eylog.co.uk/public/v1/oauth/token
Content-Type: application/json

{
  "grantType": "client_credentials",
  "clientId": "YOUR_CLIENT_ID",
  "clientSecret": "YOUR_CLIENT_SECRET"
}

Include the returned access token as a bearer token in every protected request:

Authorization: Bearer YOUR_ACCESS_TOKEN

When the access token expires, use the refresh token returned by the token request:

{
  "grantType": "refresh_token",
  "refreshToken": "YOUR_REFRESH_TOKEN"
}

Refresh tokens are single-use. Each refresh request returns a new token pair and invalidates the previous refresh token.

Make your first request

After authentication, you can start by listing the companies available to your client:

GET https://<your-tenant-subdomain>.eylog.co.uk/public/v1/companies?page=1&pageSize=25
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

Use the company and nursery identifiers returned by the API when making requests for a specific nursery.

How responses are returned

Successful responses use a consistent response envelope:

{
  "status": true,
  "code": 200,
  "message": "OK",
  "data": {},
  "correlationId": "<correlation-id>",
  "apiVersion": 1
}

The data field contains the resource object or collection array directly; it is not wrapped in another named property.

Keep the correlationId when contacting support about a failed request.

What can you do with the API?

For detailed routes, query parameters and request/response examples, use the Postman documentation.

API scopes

Your client is assigned scopes that control which areas of the API it can use:

The scopes assigned to your client are included in the token response. A scope does not provide access to every nursery; access is also limited by your API licence and client permissions.

Common problems

API updates

The eyworks Public API is expanded over time. The following capabilities are currently available: