Getting Started

Overview

Stationwise API provides programmatic access to data and functionality within the Stationwise platform. The API follows REST principles, uses JSON for data serialization, and requires token-based authentication.

Important Notice: Only endpoints listed in this documentation are publicly available for external use. All other endpoints are for internal use only and should not be accessed by third-party integrations.

Available APIs

The following endpoints are officially supported for third-party integration:

Department Information

• My Department (/api/organization/my-department/)
  • Retrieves comprehensive information about the authenticated user's department
  • Includes battalion structure, teams, pay codes, ranks, certifications, and settings
  • Available to all authenticated users

Employee Data

• Team Employees (/api/employee/team/)
  • Lists employees of the department with basic information
  • Supports search functionality for filtering employees
• Individual Employee (/api/employee/team/{id}/)
  • Retrieves detailed information about a specific employee
  • Includes ID, name, and rank information

Shift Management

• External Roster (/api/shift/external/roster/)
  • Provides comprehensive shift roster information
  • Includes date, battalion, stations, shift teams, employees, and assignments
  • Provides details on apparatus assignments, certification requirements, and position details

Payroll Information

• Employee Pay Periods (/api/payroll/)

  • Lists employee pay periods with detailed payroll information
  • Includes working hours, overtime, signing status, and comp time data
  • Supports filtering by various criteria and search by employee names

• Time Off Accruals (/api/payroll/time-off-accruals/)

  • Provides time off accrual information
  • Lists accrual amounts, limits, and associated pay codes

Rate Limiting

To ensure system stability, API requests are subject to rate limiting:

• Standard tier: 60 requests per minute
• Contact support for increased limits for integration needs

Support and Resources

For additional help with the Stationwise API:

• Email [email protected] with specific questions
• For production integrations, consider requesting a dedicated support channel

API Stability and Versioning

• Only endpoints listed in this documentation are considered stable and appropriate for external use
• We follow semantic versioning for our API
• Deprecated endpoints will be marked in the documentation and maintained for at least 6 months
• Subscribe to our developer newsletter for updates on API changes

Best Practices

1. Cache frequently accessed, rarely changing data
2. Implement proper error handling and retry logic
3. Use appropriate pagination for large data sets
4. Limit requests to only the data you need
5. Follow security best practices for handling authentication tokens

This guide provides a starting point for working with the Stationwise API. For detailed information about specific endpoints, parameters, and response formats, refer to the complete API reference documentation.