Authenticate API requests with an access token scoped to calendars.write. Use the OAuth 2.0 flow to obtain tokens and refresh them as needed.
Authorize the AccuLynx app to access Calendars API resources and grant the calendars.write scope.
The endpoint catalog below covers calendars, calendars groups and resources including create read update and delete operations.
Trigger: when a new job is added in AccuLynx automatically create a calendar in Calendars API.
Actions: post to /calendars/ to create calendars and push updates as events.
POST /calendars/
Key fields include name timeZone owner and color
Trigger: fetch calendars for upcoming events or availability as needed
Actions: list calendars get free slots via GET /calendars/:calendarId/free-slots and read calendar details
GET /calendars/ and GET /calendars/:calendarId
Query params may include calendarId date range and showSlots
Trigger: changes in AccuLynx calendar metadata
Actions: update calendars PUT /calendars/:calendarId and manage groups endpoints 11 12 13 14 15 16
PUT /calendars/:calendarId
Key fields: calendarId updates
Automate scheduling without writing code. Set up triggers and actions to sync calendars between AccuLynx and Calendars API.
Real time sync between systems. Events and availability update instantly across platforms.
Centralized calendar management reduces manual updates and confusion.
This section defines core concepts including endpoints authentication resources and data flow between Calendars API and AccuLynx.
A URL you call to perform a specific action in the API such as creating or listing calendars
Authorization framework used to obtain access tokens for API calls
A calendar object that stores events availability and time zones
A callback URL that receives event notifications from the API
Automatically create calendar events when a new job is entered in AccuLynx
Sync resource calendars to help plan crews and equipment
Embed live availability in AccuLynx dashboards for faster scheduling
Create API credentials in Calendars API and authorize the AccuLynx app
Grant calendars.write scope and set up webhooks if needed
Test calls and confirm data flows between systems before going live
The Calendars API provides programmatic access to calendars and events for scheduling and availability. You can create new calendars fetch existing ones update details and delete calendars as needed. This enables automated workflows between AccuLynx and calendars so teams stay coordinated and responsive.
To connect, request calendars.write scope and ensure appropriate permissions in your OAuth configuration. For read only access you can use calendars.readonly endpoints which do not require write permissions. Always follow least privilege principles.
Authentication uses OAuth 2.0. Obtain an access token by completing the authorization flow and include the token in the Authorization header of each API call. The AccuLynx app must be authorized to access the Calendars API and tokens should be refreshed when they expire.
Yes you can read calendars via GET endpoints and write via POST PUT and DELETE endpoints depending on your token scopes. Ensure the token includes calendars.write for write operations and calendars.readonly for read operations.
Supported endpoints include creating updating listing and deleting calendars, managing calendar groups and resources, and retrieving availability. For groups you can also validate slugs delete and change status. Refer to the endpoint catalog for details on each operation.
Test the integration in a sandbox using test tokens and sample data. Monitor API responses and logs, handle 429 rate limit responses with exponential backoff, and implement proper retries and error handling.
Rate limits vary by plan and endpoint. Observe Retry-After responses and implement backoff. Practice good hygiene with pagination, caching of repetitive calls, and validating payloads before sending requests.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
