Using the Data Access Check API endpoints

You can verify data access permissions and trigger permission checks programmatically using our API endpoints. This is useful for validating integration setup and permissions before attempting write operations.

Checking Current Data Access Status

To check the current data access permissions status for your integrations, use the GET integration interfaces endpoint:

GET /api/v1/admin/integrations

This endpoint returns data access records for all your integrations as part of the response in the integration_interfaces field.

Triggering a Data Access Check

You can trigger a fresh data access check for an integration using:

POST /api/v1/admin/integrations/{integration_id}/trigger-data-access-check

This endpoint will initiate a new check of the integration's data access permissions. For detailed documentation, see our API Reference.

Common Use Cases

• Validating integration setup during client onboarding

• Performing daily permission health checks

• Verifying write access before attempting data modifications

• Troubleshooting integration permission issues