Skip to main content

​
Integration Specifications

​
Prerequisites

​
Finding the workspace key

Use your Astronomer Organization ID as the workspace key.
  1. After logging in to Astronomer, select Settings from the left-side menu. Astronomer left-side menu with Settings highlighted
  2. On the Organization Settings screen that appears, note the Organization ID. This value is the workspace key. Organization Settings screen with the Organization ID value (masked) highlighted

​
Getting your API token

  1. On the same Organization Settings screen, click API Tokens under Access Management. Access Management section of Organization Settings with API Tokens highlighted
  2. Click New Organization API Token.
  3. In the dialog that appears, fill in the required fields. Select Organization Owner for ORGANIZATION ROLE, and click Create API Token. The screenshot shows the dialog right after it opens, with Organization Member selected. Change it to Organization Owner. Create API Token dialog with Organization Owner and the Create API Token button highlighted
  4. Click Copy to the right of the displayed token to copy it, then save it. The token is shown only on this screen, so make sure to save it now. API Token Created screen with the Copy button highlighted (token value masked)
See also Astronomer’s Create and manage Organization API tokens (external site).
  • Astronomer has no API for removing organization members. Admina can remove only pending invitations that were sent from Admina. Remove accepted members in the Astronomer console.
  • A notice may appear below ORGANIZATION ROLE: “Non-Owner Organization roles are limited with your current plan. 0 of 2 role assignments used.” It means your Astronomer plan limits how many roles other than Organization Owner you can assign.

​
Setting up the integration

  1. On the integration screen, search for Astronomer.
  2. Enter the Organization ID you found into Workspace key and the API token you copied into API key, then click Connect. Workspace name is optional. Astronomer integration setup screen showing the Workspace name, Workspace key, and API key fields
  3. Once the integration with Astronomer succeeds, registered user information appears in the account list. If it doesn’t complete successfully, first try the steps in Troubleshoot SaaS integration errors. If that doesn’t resolve it, check Information to provide and contact support.
Last modified on November 5, 2026