Fountain API Overview

Fountain's Developer APIs enable Fountain's clients to access and modify their hiring data.

If you are a Fountain partner, please refer to partners.fountain.com for guides on integrating with Fountain.

Fountain API Overview

Fountain's REST APIs let you manage applicants and workers, automate tasks, react to changes, and synchronize external systems across the product suite.

Use the shared Documentation section for authentication, webhooks, integration guides and API behavior. API Reference groups the public endpoints by Hire, Referrals, Pool, I-9, Compliance, Onboard, Shift and Platform. Hire Go and Source belong with Hire where public endpoints are available; I-9 v1 and v2 share the I-9 group.

Get started

Follow Authentication to create API credentials, obtain an OAuth access token and make your first request.

Create API Key dialog showing where to copy the Key and Secret

If you already use a Hire API token or tenant-specific URL, see Integration migration.

API base URL

Use https://services.fountain.com. Hire requests use /api/servicehire/v2/…; WX requests retain their documented service paths. The Hire gateway resolves your tenant from the OAuth token, so use the documented OAuth token endpoint rather than a token from another login endpoint.

Choose the right resource

Hire Shifts describes the working-hour options attached to Hire openings. Shift > Shifts manages scheduled worker shifts. These are different resources.

Hire locations, location groups, positions, users and roles remain under Hire because existing hiring integrations use those contracts and identifiers. The similarly named Platform resources are not automatic replacements. Use the resource documented for your workflow rather than substituting an identifier from another API.

Platform > Location Groups includes the group hierarchy operations. A hierarchy is the nested parent-and-child structure of location groups; it is not a separate product.

Platform > Custom Attributes > Attribute Sections organizes custom attributes into sections on the worker profile. A custom attribute's attributeSectionUuid identifies its section.

Referrals contains incentives, referral campaigns and referral settings. Shared files, signatures, OAuth tokens and organization resources remain under Platform.

Platform > Data Pipelines contains pipeline configuration, mappings and execution events.