Administrate

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

Base URL

The base URL used for all Administrate API endpoints:

https://api.getadministrate.com

Endpoints Utilized

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

Method	Endpoint	Purpose	Docs
GET	https://auth.getadministrate.com/oauth/authorize	Request authorization
POST	https://auth.getadministrate.com/oauth/token	Get and refresh access token

---

Authentication & Authorization

The DataGrail Administrate integration connects using OAuth 2.0 with the following credentials: Client ID and Client Secret.

Sensitive Credentials

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

---

Limits

Limits in Administrate 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 Administrate 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 Contacts whose email matches the configured identifiers.
2. For all collected contacts:
   • Fetch Opportunities by the Contact ID.
   • Fetch Learners by the Contact ID.
   • Fetch Events by the Contact ID.
   • Fetch Memberships by the Contact ID.
   • Fetch Registrations by the Contact ID.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
POST	/graphql	Send GraphQL request to search contacts and related objects

---

Deletion

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

Data Interactions

Depends on the Deletion Options for a deletion request, DataGrail will take the following actions::

Delete option:

• Fetch all Opportunities by ID of the Contact that should be removed.
• Delete all detected Opportunities.
• Delete Contact.

Anonymize option:

• Update Contact to anonymize all PII data.

Unsubscribe option:

• Update Contact by marking UnsubscribeFromCommunications as true.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
POST	/graphql	Send GraphQL request to delete or anonymize contacts and related objects

---