API reference
Everything the External API can do, by module. Pick a module to see what you can do in it, then open any operation for its details.
535 operations in 23 modules · External API v1.0.0 · base URL https://api.fetchfido.ai · Download the OpenAPI document
Start
Work
- RequestsRequests in the client, consumer and provider portals: create, update, hold, cancel, accept and decline.27 operations
- AssignmentsCreate, update, cancel and reassign assignments; mark no-shows; read and export.36 operations
- ShiftsCreate, update, reassign and delete shifts; mark no-shows; read and export.19 operations
- ScheduleThe calendar: assign providers, check availability, and the overview for each portal.8 operations
- Check-insProvider sign-in and sign-out records.2 operations
People
- ClientsClients and their locations, plus the consumers and locations a client manages in its own portal.36 operations
- ConsumersThe people services are booked for: create, update, look up guardians, export, and the consumer portal.15 operations
- ProvidersService providers: create, update, delete, qualifications, exports, and the provider portal dashboard.19 operations
- TeamSchedulers (create, update, delete, export, resend an invite) and the roles that decide what they can do.11 operations
- HandshakesBring a provider into your organization: invitations, documents, rates and offers.21 operations
Money
Forms and history
- FormsCustom forms and fields: create, update, archive, and the request forms the portals show.15 operations
- History and logsThe audit record of who changed what and when.3 operations
Settings
- General settingsOrganization details and lookup lists: categories, tags, industries, ethnicities, identities, communication modes, consumer types, relationships, statuses, time zones, travel radius.77 operations
- Service setupService types, provider types, certifications, clearances, skills, specializations, insurances, rate types, shift blocks, priorities and statuses.77 operations
- Rates and billingService type rates, provider rates, reimbursable expenses and rate and billing settings.26 operations
- NotificationsIn-app notifications, which events notify whom, communication settings and default access.20 operations
- Broadcast and dispatchHow work is offered to providers: priority-based and rate-based rounds.14 operations
- Assignment and shift rulesOrganization-wide rules for assignments and shifts.2 operations
- Organization locationsYour organization’s own locations.11 operations
- Preferred listsPreferred pairs: who a client, consumer or provider wants matched first, with notes.15 operations
- Restricted listsRestricted pairs (the block list): people who must not be matched with each other.15 operations