--- title: Square API Integration on Truto slug: square category: HRIS canonical: "https://truto.one/integrations/detail/square/" --- # Square API Integration on Truto **Category:** HRIS **Status:** Generally available ## Unified APIs ### Unified HRIS API - **Companies** — Companies represent the companies in HRIS - **Employees** — Represents an employee in HRIS - **Locations** — Locations represent the locations in HRIS - **Timeoff Types** — Represent the time off types in a company ## How it works 1. **Link your customer's Square account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Square.** The Proxy API is a 1-to-1 mapping of the Square API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Sync Square employee rosters into your SaaS product automatically** — SaaS companies serving SMB merchants can pull employee profiles, job titles, pay rates, and location assignments directly from Square — eliminating manual CSV uploads and ensuring their product always reflects the merchant's current workforce. - **Automate onboarding and offboarding workflows based on Square hiring events** — When a merchant adds or terminates an employee in Square, your product can detect the change and automatically provision or revoke access, assign training, or update compliance records without any manual intervention. - **Map employees to locations for multi-site workforce tools** — For SaaS products that serve multi-location retailers, restaurants, or franchises, syncing Square's location-to-employee assignments ensures scheduling, communications, and compliance features always reflect where each worker is stationed. - **Streamline benefits enrollment with real-time census data from Square** — Benefits administration and HR compliance platforms can pull demographic data, hire dates, and employment status from Square to automate census collection and manage enrollment windows — replacing the back-and-forth of spreadsheet requests with merchants. - **Power time-off-aware scheduling with Square leave type data** — Workforce management SaaS products can read time-off types and employee assignments from Square to ensure published schedules respect approved PTO and only include active employees at the correct locations. ## What you can build - **Auto-populated org chart from Square team data** — Automatically build and maintain company org structures by syncing employees, their job titles, and manager relationships from Square into your product. - **Location-aware employee directory** — Display a live, filterable employee directory organized by Square location, so users always see who's assigned where across multiple stores or sites. - **New hire detection and automated task assignment** — Detect when a new employee appears in Square and automatically trigger onboarding workflows like training assignments, document requests, or access provisioning in your product. - **Termination-triggered access revocation** — Automatically revoke product access or flag compliance actions when an employee's status changes to inactive or terminated in Square. - **Automated benefits census sync** — Pull company and employee data from Square on a recurring basis to keep benefits enrollment records current without requiring merchants to export and upload spreadsheets. - **Time-off type mapping for scheduling engines** — Sync Square's configured time-off types into your scheduling or workforce planning product so managers can build rosters that account for PTO, sick leave, and other leave categories. ## FAQs ### What HRIS data can I access from Square through Truto? Truto's Unified HRIS API maps Square data to four core resources: Companies, Employees, Locations, and Timeoff Types. This covers employee profiles, job titles, employment status, location assignments, and leave type configurations. Specific tools are built on request to match your requirements. ### How does authentication work for Square integrations on Truto? Square uses OAuth 2.0 for third-party integrations. Truto manages the full OAuth flow — token exchange, storage, and refresh — so your end users simply authorize their Square account through a connect flow and you never handle raw credentials. ### Is the Square integration available out of the box or built on request? Square is listed as a supported HRIS integration on Truto with Unified API coverage for Companies, Employees, Locations, and Timeoff Types. Specific proxy or custom tools for Square's Team API, Labor API, or Payroll API endpoints are built on request based on your use case. ### What types of businesses will connect their Square accounts through my product? Typically SMBs with 1–100 employees in retail, food & beverage, salons, fitness, and field services. These merchants use Square as their primary business operating system and expect integrations to just work without manual data entry. ### Does Truto handle Square API pagination and rate limits? Yes. Truto abstracts away Square's cursor-based pagination and manages rate limit handling, so you interact with a consistent Unified API without writing Square-specific retry or pagination logic. ### Can I access Square data for employees across multiple locations? Yes. Square's data model assigns employees to one or more locations, and this mapping is exposed through Truto's Unified HRIS API via the Employees and Locations resources, enabling multi-site roster syncing.