Gem

This documentation for the Gem integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Gem, visit our connection instructions.

Version

This integration utilizes the Gem REST API v0.

Base URL

The base URL used for all Gem API endpoints:

https://api.gem.com/v0

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	/candidates	Validate credentials
GET	/users	Fetch Admin ID

---

Authentication & Authorization

The DataGrail Gem integration connects using API Key authentication which requires an API Key.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Gem API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

---

Limits

Limits in Gem are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's Gem integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Search for Candidates using the Data Subject email address.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/candidates	Search candidates

---

Deletion

DataGrail's Gem integration provides Synchronous Deletion capabilities for the following supported identifier category: Email.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

1. Search for Candidates using the Data Subject email address.
2. Delete Candidates from the account.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/candidates	Search candidates
GET	/candidates/candidate_id	Delete candidate

---