This guide shows you how to make your first Userorbit API request.

Before you begin

  • You need access to a Userorbit workspace.

  • You need permission to create or view API keys.

Step 1: Create an API key

  1. Open the Userorbit dashboard.

  2. Go to Settings > API Keys.

  3. Create a key and copy it to a secure place.

  4. Copy your Team ID from the same page.

Step 2: Send your first request

Userorbit API endpoints use POST requests to action-style endpoint names.

curl -X POST https://api.userorbit.com/api/v1/feedbacks.list   -H "Authorization: Bearer YOUR_API_KEY"   -H "x-team-id: YOUR_TEAM_ID"   -H "Content-Type: application/json"   -d '{}'TypeScript

Step 3: Create a test feedback item

curl -X POST https://api.userorbit.com/api/v1/feedbacks.create   -H "Authorization: Bearer YOUR_API_KEY"   -H "x-team-id: YOUR_TEAM_ID"   -H "Content-Type: application/json"   -d '{"title":"Test feedback from the API"}'TypeScript

Response shape

Most endpoints return either a single data object or a paginated list with pagination and data.

Next steps

Use the API reference to choose the resource you want to automate, such as feedback, announcements, roadmap topics, help center articles, subscribers, projects, or tags.

Choose the API key scope

Choose Read only — recommended for integrations that only retrieve data. Choose Read & write when the integration must create, update or delete resources. A key created with the default read-only scope cannot perform the write examples in this guide.

Copy the full key when it is created and store it securely. The key list shows a fingerprint, not a way to retrieve the full secret again. Revoke a key when it is no longer needed.

Was this helpful?