Getting Started

The SuiteOp Public API exposes the same operations your dashboard uses over a conventional REST interface. Every operation is authenticated with a secret key scoped to your organization.

Base URLs

The API is multi-region. All requests must go to the region where your organization’s data lives. Using the wrong region returns a 404 or 401 depending on the endpoint.

Region	Base URL
US	https://api-us.suiteop.com/api/v1
EU	https://api-eu.suiteop.com/api/v1
APAC	https://api-apac.suiteop.com/api/v1

Your organization’s region is shown in Settings → Organization → General. If you are unsure, the US region is the default for accounts created before regional selection was introduced.

Creating an API Key

1. Open the SuiteOp dashboard and go to Settings → API Keys.

2. Click Create API Key, give it a name, and select the permission scopes your integration needs.

3. Copy the key immediately — it is shown only once. Store it in a secrets manager (environment variable, AWS Secrets Manager, GCP Secret Manager, etc.).

Caution

Keys cannot be retrieved after creation. If you lose a key, revoke it and create a new one.

Keys are prefixed with sk_live_ for production or sk_test_ for sandbox environments.

First Request

Retrieve your open tasks with a single curl call. Replace <region> with us, eu, or apac, and <key> with your API key.

curl https://api-<region>.suiteop.com/api/v1/tasks \
  -H "Authorization: Bearer sk_test_your_key_here"

Response Envelope

Every response is wrapped in a consistent envelope:

Success (single resource)

{
  "data": { "id": "...", "title": "Clean Unit 12B", "status": "open" },
  "meta": { "requestId": "req_01j..." }
}

Success (list)

{
  "data": [
    { "id": "...", "title": "Clean Unit 12B", "status": "open" }
  ],
  "meta": {
    "requestId": "req_01j...",
    "pagination": { "total": 42, "limit": 20, "offset": 0 }
  }
}

Error

{
  "error": {
    "type": "not_found_error",
    "code": "task_not_found",
    "message": "Task not found."
  },
  "meta": { "requestId": "req_01j..." }
}

The meta.requestId field uniquely identifies every request. Include it when contacting support.

Interactive Reference

The full operation reference is available at:

• US: https://api-us.suiteop.com/api/docs
• EU: https://api-eu.suiteop.com/api/docs
• APAC: https://api-apac.suiteop.com/api/docs