Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ license: MIT
compatibility: Requires network access to fetch live documentation from docs.stackone.com
metadata:
author: stackone
version: "2.0"
version: "2.1"
---

# StackOne Platform
Expand All @@ -18,6 +18,10 @@ Before answering platform questions, fetch the latest documentation:

Do not guess or rely on potentially outdated information in this skill. Always verify against live docs.

When fetching any `docs.stackone.com` page, append `.md` to the URL to get it as markdown.
Comment thread
faisalreza-stackone marked this conversation as resolved.
Outdated

**If any URL in this skill returns 404, or a page doesn't cover what you need** (StackOne reorganizes its docs from time to time), search `llms.txt` for the page's topic (e.g. "Authentication", "Rate Limiting", "List Accounts", "Webhooks") and use the URL listed there. If the docs don't cover the question, say so and suggest contacting StackOne support.

## Instructions

### Step 1: Identify what the user needs
Expand All @@ -35,7 +39,7 @@ StackOne is integration infrastructure for AI agents — connectors and 30,000+
All API calls require Basic auth. The API key goes in the Authorization header:

```bash
curl https://api.stackone.com/accounts \
curl https://api.stackone.com/v2/accounts \
-H "Authorization: Basic $(echo -n 'YOUR_API_KEY:' | base64)"
```

Expand All @@ -48,21 +52,15 @@ Key details:

### Step 3: Account management

Each linked account has:
- `id` — assigned by StackOne
- `provider` — the SaaS tool (e.g., `bamboohr`, `greenhouse`)
- `origin_owner_id` — your internal customer identifier
- `status` — `active`, `error`, `inactive`

To list accounts: `GET https://api.stackone.com/accounts`
To get one account: `GET https://api.stackone.com/accounts/{id}`
To list accounts: `GET https://api.stackone.com/v2/accounts`
To get one account: `GET https://api.stackone.com/v2/accounts/{id}`

Fetch the accounts API reference for full details:
`https://docs.stackone.com/platform/api-reference/accounts/list-accounts`
Fetch the List Accounts reference for each account's fields and status values:
`https://docs.stackone.com/platform/api-reference/v2/accounts/list-accounts.md`

### Step 4: Fetch API docs as needed

Consult `references/api-categories.md` for the StackOne API structure (Actions API, Platform API) and connector category documentation URLs.
Consult `references/api-categories.md` for the StackOne API structure (Actions API, Platform API) and where connector documentation lives.

## Examples

Expand All @@ -72,9 +70,9 @@ User says: "How do I see which accounts are connected in StackOne?"

Actions:
1. Confirm they have an API key (created at https://app.stackone.com)
2. Show the curl command: `GET https://api.stackone.com/accounts` with proper auth header
3. Explain the response fields: `id`, `provider`, `status`, `origin_owner_id`
4. Fetch `https://docs.stackone.com/platform/api-reference/accounts/list-accounts` for the full schema
2. Show the curl command: `GET https://api.stackone.com/v2/accounts` with proper auth header
3. Fetch `https://docs.stackone.com/platform/api-reference/v2/accounts/list-accounts.md`
4. Explain the response fields and status values from the reference

Result: Working command with explanation of account statuses and how to use account IDs.

Expand All @@ -85,8 +83,8 @@ User says: "My StackOne API call is returning 401"
Actions:
1. Check if their API key is correctly base64-encoded (common mistake: forgetting the trailing colon)
2. Verify the key hasn't been revoked in the dashboard
3. If they get 200 on `/accounts` but fail on data endpoints, check that `x-account-id` is present and valid
4. Fetch `https://docs.stackone.com/overview/authentication` for the latest auth details
3. If they get 200 on `/v2/accounts` but fail on data endpoints, check that `x-account-id` is present and valid
4. Fetch `https://docs.stackone.com/platform-api/authentication.md` for the latest auth details

Result: Identified root cause with fix.

Expand All @@ -100,14 +98,14 @@ Result: Identified root cause with fix.

### Error: 400 Bad Request with "account not found"
**Cause**: The `x-account-id` header references a non-existent or disconnected account.
- List accounts with `GET /accounts` to find valid IDs
- List accounts with `GET /v2/accounts` to find valid IDs
- Check the account status — it may be `error` or `inactive`

### Error: 429 Too Many Requests
**Cause**: Rate limit exceeded.
- StackOne applies rate limits per API key
- Implement exponential backoff
- Fetch `https://docs.stackone.com/overview/rate-limits` for current limits
- Fetch `https://docs.stackone.com/platform-api/rate-limiting.md` for current limits

### API calls return empty data
**Cause**: The linked account may have limited permissions on the provider side.
Expand All @@ -121,5 +119,6 @@ Result: Identified root cause with fix.
|----------|-----|
| Dashboard | https://app.stackone.com |
| API base | https://api.stackone.com |
| Documentation | https://docs.stackone.com |
| Documentation | https://docs.stackone.com/introduction.md |
| Docs index | https://docs.stackone.com/llms.txt |
| Webhooks | https://docs.stackone.com/connect/webhooks.md |
Original file line number Diff line number Diff line change
Expand Up @@ -13,39 +13,29 @@ POST https://api.stackone.com/actions/rpc
Actions are named `{provider}_{operation}_{entity}` (e.g., `bamboohr_list_employees`, `salesforce_get_contact`).

For the full Actions API reference, fetch:
`https://docs.stackone.com/platform/api-reference/actions/make-an-rpc-call-to-an-action`
`https://docs.stackone.com/platform/api-reference/actions/make-an-rpc-call-to-an-action.md`

To discover available actions for a provider, fetch:
`https://docs.stackone.com/connectors/introduction`
`https://docs.stackone.com/connectors/introduction.md`

## Platform API

The Platform API handles account management, not data operations:

| Endpoint | Purpose |
|----------|---------|
| `GET /accounts` | List linked accounts |
| `GET /accounts/{id}` | Get a specific linked account |
| `GET /v2/accounts` | List linked accounts |
| `GET /v2/accounts/{id}` | Get a specific linked account |
| `POST /connect_sessions` | Create a connect session for account linking |

For the full Platform API reference, fetch:
`https://docs.stackone.com/platform/api-reference/accounts/list-accounts`
`https://docs.stackone.com/platform/api-reference/v2/accounts/list-accounts.md`

The "Platform API" section of `https://docs.stackone.com/llms.txt` lists every reference page (Accounts, Actions, Connect Sessions, Connector Profiles, Connectors, Logs, Webhooks and more).

## Connector Categories

Connectors are organized into categories. Fetch the category introduction pages for details on available providers:

| Category | Documentation |
|----------|--------------|
| HRIS | https://docs.stackone.com/hris/introduction |
| ATS | https://docs.stackone.com/ats/introduction |
| CRM | https://docs.stackone.com/crm/introduction |
| LMS | https://docs.stackone.com/lms/introduction |
| IAM | https://docs.stackone.com/iam/introduction |
| Documents | https://docs.stackone.com/documents/introduction |
| Accounting | https://docs.stackone.com/accounting/introduction |
| Ticketing | https://docs.stackone.com/ticketing/introduction |
| Messaging | https://docs.stackone.com/messaging/introduction |
Connectors are organized into categories such as HRIS, ATS, CRM, LMS, IAM, Documents, Accounting and Ticketing. Fetch `https://docs.stackone.com/connectors/introduction.md`, which tags each connector with its categories, and filter by the category. Each connector's own page lists its actions.

## Authentication

Expand Down
Loading