{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"61a47545-1c31-4934-a301-acf2669e0faf","name":"eyworks - Public API","description":"# **eyworks Public API**\n\nThe eyworks Public API provides secure, authenticated access to selected data in the eyworks platform for customer integrations, reporting, business intelligence tools and connected applications.\n\n## **Before you start**\n\nYou will need:\n\n| Requirement | Details |\n| --- | --- |\n| API licence | An active API licence for each nursery you want to connect. |\n| API credentials | A `clientId` and `clientSecret` issued by eyworks. |\n| Tenant address | Your organisation's eyworks tenant address. |\n| Technical setup | A system or technical team to make the API requests. |\n\nAPI credentials are issued for your tenant and are limited to the nurseries and permissions covered by your licence.\n\n## **Request API access**\n\nOnce your API licence is active, the eyworks support team can generate your tenant-specific integration credentials.\n\nTo discuss API licensing or arrange a licence, email [sales@eyworks.co.uk](mailto:sales@eyworks.co.uk). For credentials, onboarding or technical questions, contact [support@eyworks.co.uk](mailto:support@eyworks.co.uk).\n\n## **Set up the collection**\n\nFork or import this collection into your own Postman workspace and set these values locally:\n\n| Variable | Value |\n| --- | --- |\n| `baseUrl` | Your tenant address, for example `https://your-tenant.eylog.co.uk` |\n| `clientId` | The client ID issued by eyworks. |\n| `clientSecret` | The client secret issued by eyworks. |\n\nDo not add a trailing slash to `baseUrl`. The collection does not include customer credentials or a shared environment.\n\n## **Get an access token**\n\n1. Set your local `baseUrl`, `clientId` and `clientSecret` values.\n2. Open **Auth > Create Token (Client Credentials)**.\n3. Send the request.\n4. The collection saves the returned access and refresh tokens locally in your Postman environment.\n5. Use the access token for protected requests.\n\nThe token endpoint is:\n\n`POST /public/v1/oauth/token`\n\nUse the returned token in the following header:\n\n`Authorization: Bearer <accessToken>`\n\nWhen the access token expires, use **Auth > Refresh Token**. Refresh tokens are single-use and are rotated when refreshed.\n\n## **API scopes**\n\nYour client is assigned scopes that control which areas of the API it can use:\n\n| Scope | Access |\n| --- | --- |\n| `company:read` | Company data. |\n| `nurseries:read` | Nursery data, rooms, sessions and company nursery lists. |\n| `employee:read` | Employee data, qualifications and training. |\n| `children:read` | Child data. |\n| `enquiries:read` | Enquiry data and enquiry lookup values. |\n| `enquiries:write` | Submit enquiries. |\n| `availability:read` | Nursery availability data. |\n| `financials:read` | Child financial data. |\n\nThe scopes assigned to your client are included in the token response. A scope does not provide access to every nursery; your client can only access the nurseries covered by its licence and configuration. A request that requires an unassigned scope returns `403 Forbidden`.\n\n## **Response format**\n\nEvery response uses the standard envelope:\n\n```json\n{\n  \"status\": true,\n  \"code\": 200,\n  \"message\": \"OK\",\n  \"data\": {},\n  \"correlationId\": null,\n  \"apiVersion\": 1\n}\n```\n\nCollection endpoints return an array in `data`; detail endpoints return an object. Error responses use `status: false` and include a client-safe message.\n\n## **Pagination**\n\nCollection endpoints support `page` and `pageSize`.\n\n- `page` starts at 1.\n- `pageSize` defaults to 50 and accepts values from 1 to 100.\n- Pagination details are returned under `metadata.pagination`.\n- Financial collections also return `metadata.snapshotAt`; use the same filters when retrieving all pages.\n\n## **Identifiers**\n\nUse the public GUIDs returned by the API in subsequent requests. Do not use internal database IDs or try to guess identifiers.\n\n## **Run the collection in Postman**\n\nUse the built-in **Run in Postman** option to fork or import this collection into your own workspace. Enter your tenant-specific values locally before sending requests.\n\n## **API updates**\n\nNew capabilities are added to the eyworks Public API over time. The latest available capabilities are:\n\n| Available from | Area | Capability |\n| --- | --- | --- |\n| 18 August 2026 | Enquiries | Create an enquiry for a nursery using `POST /nurseries/{guid}/enquiries`. |\n| 18 August 2026 | Nursery settings | Retrieve enquiry lookup values and available sessions to support nursery integrations. |\n| 18 August 2026 | Nursery availability | Retrieve nursery availability using `GET /nurseries/{guid}/availability`. If no segment is supplied, the response uses a nursery-level breakdown. |\n| 26 August 2026 | Child financials | Retrieve child financial summaries, invoices, payments, credits and transactions. |\n\n## **Need help?**\n\nFor API licensing or licence agreements, email [sales@eyworks.co.uk](mailto:sales@eyworks.co.uk). For credentials, onboarding or technical questions, email [support@eyworks.co.uk](mailto:support@eyworks.co.uk).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"30375394","team":507235,"collectionId":"61a47545-1c31-4934-a301-acf2669e0faf","publishedId":"2sBYAq1tfD","public":true,"publicUrl":"https://documenter-api.postman.tech/view/30375394/2sBYAq1tfD","privateUrl":"https://go.postman.co/documentation/30375394-61a47545-1c31-4934-a301-acf2669e0faf","customColor":{"right-sidebar":"303030","highlight":"FF5E2C","top-bar":"FFFFFF"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"title","value":"eyworks Public API Documentation | eyenquiries APIs, eymanage APIs and Invoice APIs"},{"name":"description","value":"Customer-facing documentation for eyenquiries APIs, eymanage APIs and Invoice APIs, including authentication, scopes, request and response examples."}],"appearance":{"themes":[{"name":"dark","colors":{"right-sidebar":"303030","highlight":"FF5E2C","top-bar":"FFFFFF"},"logo":null},{"name":"light","colors":{"right-sidebar":"303030","highlight":"FF5E2C","top-bar":"FFFFFF"},"logo":null}],"default":"dark"}},"version":"8.12.3","publishDate":"2026-08-26T14:35:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"eyworks Public API Documentation | eyenquiries APIs, eymanage APIs and Invoice APIs","description":"Customer-facing documentation for eyenquiries APIs, eymanage APIs and Invoice APIs, including authentication, scopes, request and response examples."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/235c731b36fc86cfd9cc0e8d3ea05d17b297f1209fbc851e50f3f7b430328833","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBYAq1tfD"}