Admin API: Launch
Managing a growing ecosystem of workspaces, users, and integrations shouldn't require logging into every tool or tracking down credentials by hand. The Admin API puts enterprise workspace management at your fingertips — provision workspaces, onboard users, and govern Interactions API access all from a single, programmatic interface. Whether you're scaling a campaign organization or coordinating across a partner network, the Admin API gives you central control without the operational overhead.
Campaigns and Organizations
The Admin API exposes a set of endpoints for programmatic control over your workspace topology and Interactions API configuration. Rather than relying on console-based operations, programming against the Admin API allows you to automate workspace management — onboarding, updating, and offboarding — and centrally govern which Interactions API Keys are provisioned to them, all without manual intervention.
Workspaces and Users
- Create a new workspace — Programmatically provision workspaces under your organization without manual console setup.
- View and manage workspace hierarchy — Retrieve a full tree representation of a workspace and its descendants to understand and govern your organizational structure at a glance.
- Invite a user to a workspace — Add users to a workspace directly via the API. Invited users will receive an email invitation and an accept/decline banner the next time they log in to the console.
- Delete a workspace — Decommission workspaces that are no longer needed, keeping the footprint of data and API access tightly scoped.
Interactions API Keys
- Add VAN External API Keys — Register VAN credentials as an External API Key within a workspace, enabling VAN as a destination for Interactions API data flows.
- Create an Interactions API Key with VAN as a destination — Provision a new Interactions API Key scoped to VAN, establishing the link between a data source and your VAN destination.
- Delete an Interactions API Key — Remove API Keys that are no longer active or authorized, reducing your attack surface.
Technology Partners
Sources
Maintaining a secure integration with the Interactions API starts with controlling who holds credentials and how they're retrieved. The Admin API removes the need for custom UIs or third-party tooling — API Key secrets are available directly, as a one-time retrieval, reducing the risk of credential mishandling.
- View API Key metadata for workspaces that have requested to integrate with you — See the public metadata for any API Key provisioned by a workspace that has requested an integration with your app.
- Retrieve a one-time secret for your app's API Keys — Fetch the secret for an API Key provisioned to your movement app. Secrets are only surfaced once, ensuring they remain in your control. Your workspace owners will be automatically notified by email when an API Key is generated for your app.
Destinations
As a vendor or tool that receives data via the Interactions API, knowing who is sending you data — and being able to verify it programmatically — is essential for secure ingress. The Admin API gives you full visibility into the source and data owner network without relying on manual communication or out-of-band processes.
- List all Interactions API Keys provisioned to your destination — Retrieve the public metadata for every API Key configured to route data to you, so you always know which sources and data owners are in your pipeline.
- Email notifications on new API Key setup — Your workspace owners will receive an automatic email notification whenever a new API Key is configured to link to your destination, keeping all stakeholders informed without requiring active monitoring.
