Skip to main content

​
What is Humanly Connect?

Humanly Connect is the integration layer Humanly products use to connect with external ATS, HRIS, and hiring systems. It centralizes credential storage and vendor-specific routes so each product does not build one-off integrations per customer. Typical flow: a Humanly product needs data from (or sends data to) a customer’s Workday, UKG, or similar system → Connect handles auth, routing, and the vendor contract.
Access is restricted. Connect requires credentials issued by Humanly. Endpoints reject unauthenticated or unauthorized requests. This documentation is for authorized Humanly teams and approved integration partners only.

​
Connect vs Gather

GatherConnect
PurposePhone interviews (questions, candidates, invites)External ATS/HRIS integration
Typical userCustomers and integrators building interview workflowsHumanly product teams wiring products to customer HR systems
Docs tabGatherConnect (this tab)
Some authorized integrations use Gather only, Connect only, or both. Shared authentication, scopes, and error formats are documented on the Platform tab.

​
Authentication

Product / routeHow to authenticate
Gather /qsi/gather/*Gather API key via x-api-key
Connect accounts & vendor metax-api-key only (partner or customer key, by scope)
Connect vendor data (orders, …)x-api-key (partner customer key) or Authorization: Basic (legacy direct integration)
Gather uses one API-key model. Connect meta and account routes use API keys only; data routes also accept legacy integration Basic auth for customers not yet migrated to Connect customer keys. Full detail: Platform authentication.

​
Who this documentation is for

  • Humanly product teams connecting a Humanly application to a customer’s external systems
  • Approved partners building under agreement with Humanly and holding issued API credentials
If you do not have credentials, contact your Humanly administrator or partner contact.

​
Documentation map

Getting started

End-to-end flow for authorized teams (requires issued credentials)

Platform auth

Shared authentication and API key model
Additional reference pages (account lifecycle, vendor routes, read/write conventions) assume you already have access and credentials. Start with Getting started or your Humanly engineering contact.