Gig and Workforce

Use the Data APIs to retrieve gig, shift, and pay records from accounts workers connect. Decide which records and how much history you need before choosing the webhooks to subscribe to.

​

Define the data you need

Choose only the resources your application needs:

• Gigs and Shifts for work completed, payments, and scheduled shifts.
• Identities, Paystubs, Payroll Documents, and Deposit Destinations for worker and payment records.
• Vehicles and Ratings when those resources are available from the connected source.

Resource availability and history vary by source. Check Items for the supported data sets and refresh behavior instead of assuming every connected account returns the same records.

​

Connect worker accounts

1. Create a user and retain the ID in your system.
2. Launch Link. Use direct login when the application already knows the platform the worker needs to connect.
3. Let the worker connect every account required by the workflow.
4. Store and monitor each account independently.

​

Choose a readiness window

Do not wait for complete account history when a recent window is sufficient:

• The gigs.partially_synced webhook indicates that Gigs are available through the configured number of days for one newly connected account.
• The shifts.partially_synced webhook provides the same control for Shifts.
• Use the corresponding fully-synced event when all available records for that resource are required.
• Use the users.fully_synced webhook only when processing must wait for initial delivery from every newly connected payroll account.

Partial- and fully-synced events apply to initial delivery. Reconnection and ongoing updates use account and resource events instead.

​

Process the event stream

Retrieve records through paginated list endpoints and process .added, .updated, and, where available, .removed events for the resources your application stores. Keep resource IDs so later events update or remove the correct record. Subscribe to the accounts.updated webhook with config.include_resource = true and the accounts.removed webhook to track the connection lifecycle. Return the existing user to Reconnect an Account when the worker needs to reauthenticate. See Data Delivery and Readiness for initial synchronization and Ongoing Refresh for new records after the initial delivery.