List events

get

https://integrate.rooflink.com/roof_link_endpoints/api/light/events/

Retrieves a paginated list of events for the authenticated user's company.

Permission Requirements:

Employee users: Can access all events in their company.

Event Filtering:

Only non-recurring events (recurrence="never") are returned. Events are filtered by the user's company and by the user's calendar permissions. The endpoint supports extensive filtering by date ranges, users, calendars, jobs, tags, and other criteria.

Pagination:

Results are paginated with a maximum of 10 events per page. Use the page and page_size parameters to navigate through results.

Timezone Handling:

Event times are returned in the user's local timezone. The start and end fields use a formatted display string (MM/DD/YYYY HH:MMAM/PM), while local_start and local_end provide ISO 8601 formatted timestamps with timezone information.

Query Params

page

integer

≥ 1

Defaults to 1

Page number for pagination. Each page contains up to 10 results.

page_size

integer

1 to 10

Defaults to 10

Number of results per page. Maximum and default value is 10.

start__gte

date-time

Filter events that start on or after the specified date and time (ISO 8601 format).

start__lte

date-time

Filter events that start on or before the specified date and time (ISO 8601 format).

end__gte

date-time

Filter events that end on or after the specified date and time (ISO 8601 format).

end__lte

date-time

Filter events that end on or before the specified date and time (ISO 8601 format).

calendars

string

Filter events by calendar IDs. Provide a comma-separated list of calendar IDs to filter events associated with specific calendars.

users

string

Filter events by user IDs. Provide a comma-separated list of user IDs to filter events associated with specific users' calendars.

200Events retrieved successfully. Returns a paginated list of events with user, job, and calendar information.

400Bad Request. Invalid query parameters were provided. This can occur if the page number is invalid, page_size exceeds the maximum, filter parameters contain invalid values, or date formats are incorrect.

401Unauthorized. Authentication credentials were not provided or are invalid. The request must include a valid API key in the X-API-KEY header to access this endpoint.

403Forbidden. The authenticated user does not have the required permissions to access events. This endpoint is restricted to employees and crew members only. Crew members can only access events where they are invited or attending.

429Too Many Requests. The client has exceeded the rate limit for this endpoint. Wait for the specified time period before making additional requests.

503Service Unavailable. The API rate limits for all public endpoints have been exceeded, or the service is temporarily down for maintenance. Try again later.