Prerequisites
- You must be a Gem Admin or have permission to manage integrations and API access
- Your Gem account must be connected to your ATS (e.g., Greenhouse, Lever) for full data coverage
Generate a Gem API Key
- Log in to Gem
- Navigate to Settings → Integrations → API / Developer Settings
- Select Create API Key
- Name the key clearly (e.g.,
Human Intelligence Analytics Integration) - Copy and securely store the API key — Gem will not show it again
Required API Access & Permissions
To ensure the most complete and accurate data sync, please enable all available read permissions for the API key, including the following categories:🔐 Core Recruiting Data (Required)
- Candidates / People
- Candidate profiles
- Contact information
- Source attribution
- Tags and custom fields
- Applications & Pipeline
- Job applications
- Stage progression
- Rejection / disposition reasons
- Offer status (where available)
- Jobs & Requisitions
- Job titles
- Departments
- Hiring teams
- Open / closed status
📬 Outreach & Engagement Data (Highly Recommended)
- Email Outreach
- Campaigns
- Templates
- Send timestamps
- Open / reply events
- Sequences
- Sequence membership
- Step progression
- Completion status
- Response Signals
- Reply classification (positive / neutral / negative, if enabled)
- Time-to-response
🏷 Metadata & Enrichment (Recommended)
- Custom Fields
- Tags & Labels
- User / Recruiter Data
- Recruiter ownership
- Hiring manager associations
- Team / Permission Metadata
Security & Access Notes
- API keys are encrypted at rest and in transit
- Access is scoped strictly to analytics and reporting use cases
- You may revoke the key at any time from Gem settings
Share the API Key
- Once generated, please securely share the API key with our team via your agreed secure channel.
- If you have questions during setup, we’re happy to walk through this live.