Get started

Learn what Wingspan does, how the V3 API is organized, how to authenticate, and how to pay your first contractor.

This section gets you from zero to a working Wingspan V3 integration. It explains what Wingspan does, the objects you'll work with, how to authenticate, and walks you through inviting and paying a contractor. If you already use the V1 API, start with the migration guide.

Read in this order:

  1. Wingspan overview: what Wingspan does and how the five V3 domains are laid out.
  2. Concepts: Person, Account, Payee, engagements, requirements, payables, invoices, and payroll runs, and how they relate.
  3. Environments and authentication: base URLs, headers, sessions, API keys, service accounts, OAuth, and acting on another Account.
  4. Quickstart: invite and pay a contractor: subscribe to webhooks, invite a payee, create a payable, and pay it.
  5. Glossary: definitions of the terms used across these docs, with V1 equivalents.
  6. Migrating from V1: what changed, concept and endpoint mappings, breaking field changes, and a migration order.

Did this page help you?