Skip to main content
Single-tenant Research Preview The User management API lets organization owners list, invite, update, and remove organization members programmatically. Requests are scoped to the organization and workspace associated with the API key owner.

​
Prerequisites

Before you begin, make sure you have:
  • An eligible Qodo single-tenant organization.
  • User management API access enabled for your organization. Contact Qodo Support to confirm access.
  • The organization owner role. For more information, see Roles and permissions.
  • Your Qodo tenant subdomain. Qodo provides this value when API access is enabled.
The v1 segment in /platform/v1 identifies the API contract version. It is independent of the Qodo product documentation version.

​
Quickstart

​
Create an API key

The API uses a personal sk- API key that belongs to an organization owner.
1
Log in to the Qodo portal as an organization owner.
2
Navigate to your Account settings in the bottom-left corner.
3
Click Create API Key.
4
Enter a descriptive name and select an expiration period. Use an expiring key when your integration supports rotation.
5
Click Create, copy the key, and store it in your organization’s secret manager. Qodo does not display the complete key again.
For more information, see API key management.

​
Configure your API client

Use your single-tenant Platform host as the API base URL:
All API requests use this base URL. Authenticate requests by sending your API key in the Authorization header:
Do not commit the key to source control or include it in logs. Load it from a secret manager or another protected runtime configuration.

​
Send your first request

List the members in your organization:
A successful request returns a paginated response:
Replace the placeholders before sending the request. Never paste a real API key into a shared script, ticket, or documentation page.

​
Use the API playground

  1. In the documentation navigation, open Account management > API.
  2. Select an endpoint and click Try it.
  3. Replace your-tenant with your tenant subdomain.
  4. Enter your API key in the Bearer field.
  5. Review the target host, then click Send.
Treat values entered in the playground as secrets. Verify the tenant host before sending a request, and do not forward a key automatically to a host returned in an error response.

​
Troubleshoot authentication and access

​
Removal and offboarding limitations

Removing a member does not currently revoke that member’s personal API keys. Do not use the remove-member endpoint as the only step in an automated offboarding workflow until Qodo confirms that API-key revocation is enabled for your deployment. In an organization that allows domain-based sign-up, a removed user can join again at the next sign-in. Configure invite-only access when membership must require an invitation.

​
Next steps