> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/connector-configuration/superoffice.md).

# SuperOffice CRM

Register a SuperOffice CRM Online application for the Appmixer SuperOffice CRM connector (OAuth 2 / OpenID Connect).

The SuperOffice CRM connector signs users in through SuperID, the SuperOffice CRM Online identity provider (OAuth 2.0 authorization code flow with OpenID Connect). It needs an application registered in the SuperOffice Developer Portal.

## OAuth app properties

| Property                | Value                                                                                                                                                                                                                                                                             |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Multi-tenant**        | **Conditional.** A *standard* application, once certified and published to Production, can be used by any SuperOffice CRM Online customer whose administrator approves it. A *custom* application is mapped to one specific customer tenant.                                      |
| **Vendor review**       | **Required** before Production. Standard applications go through SuperOffice certification and a mandatory security evaluation by Telenor Cyberdefense; custom applications go through a lighter validation test. Both start with **Request to Publish** in the Developer Portal. |
| **Review time**         | Not documented. SuperOffice opens a support ticket after **Request to Publish** and follows up with the technical contact.                                                                                                                                                        |
| **Users before review** | Users of your test tenant in SOD (the development environment) only. A configuration cannot be used in Stage or Production before SuperOffice approves it.                                                                                                                        |
| **App owner**           | A SuperOffice developer account (a partner in the Developer Portal). To publish a standard application you must be a cloud partner (signed sub-DPA) and pay the Telenor Cyberdefense fee. A custom application requires the customer's Development Tools subscription.            |
| **Regions**             | One Production configuration serves all production tenants; the connector looks up each tenant's API host itself. SOD, Stage and Production are separate environments, each with its own client secret.                                                                           |
| **Client secret**       | No expiry enforced: the Developer Portal accepts an expiration date but notes that it is not enforced yet. One client secret per environment; after a renewal the old secret stops working when the new configuration is published.                                               |
| **Rate limits**         | SuperOffice asks applications to make no more than 10 API calls per second.                                                                                                                                                                                                       |
| **Checked**             | 2026-11-19                                                                                                                                                                                                                                                                        |

**Limitations**

* A user can connect an account only after a SuperOffice administrator of their tenant (a user with the **General Administrator** or **User Administrator** function right) has approved the application. The approval is needed in each environment separately.
* The connector works in the user context: every component sees and changes only what the signed-in SuperOffice user may see and change.
* During SuperOffice maintenance windows the tenant can be unavailable; components then fail with a message that names the tenant state.

Sources: [Building apps for SuperOffice](https://docs.superoffice.com/en/developer-portal/getting-started/index), [Register an application](https://docs.superoffice.com/en/developer-portal/create-app), [Application environments](https://docs.superoffice.com/en/developer-portal/getting-started/app-envir), [Standard apps](https://docs.superoffice.com/en/developer-portal/standard-app/index), [Certification](https://docs.superoffice.com/en/developer-portal/standard-app/certification/index), [Custom apps](https://docs.superoffice.com/en/developer-portal/custom-app/index), [Create or renew a client secret](https://docs.superoffice.com/en/developer-portal/create-app/config/get-client-secret), [Consent](https://docs.superoffice.com/en/developer-portal/provisioning/consent), [Validation checklist](https://docs.superoffice.com/en/developer-portal/custom-app/checklist). What the rows mean: [OAuth app properties](https://docs.appmixer.com/connector-configuration/oauth-app-properties.md).

## Register the SuperOffice application

1. If you do not have a SuperOffice developer account yet, submit the developer account request on [Get access to the sandbox environment](https://docs.superoffice.com/en/developer-portal/getting-started/get-access-to-sod). SuperOffice creates a partner for your company in the Developer Portal and a test tenant in SOD, normally within one business day.
2. Sign in to the [SuperOffice Developer Portal](https://dev.superoffice.com/), go to your partner page and select **Applications** in the left menu.
3. Click **Create App**.
4. Choose the **Web application** template and whether the application is **standard** (for all your customers, listed in the App Store) or **custom** (for one customer's tenant). Click **Next**.
5. Enter the name of the application (64 characters at most). Click **Next**.
6. Enter the redirect URL `https://<your-appmixer-api>/auth/superoffice/callback` — replace the host with your Appmixer API URL and keep the suffix `/auth/superoffice/callback` (for example `https://api.acme.appmixer.cloud/auth/superoffice/callback`). Click **Next**.
7. Skip the integration points: the connector uses only the WebAPI, which every template includes. It does not use webhooks, database mirroring or the system user.
8. Set the technical contact for the application and click **Create Application**. The configuration is published to SOD automatically.
9. On the application page select **Configuration**, click **New Client Secret**, copy the secret and click **Save Settings** in the **You have unsaved changes** bar. The secret cannot be displayed again later. The client ID is shown in the same configuration (see [Check what your client ID is](https://docs.superoffice.com/en/developer-portal/create-app/config/find-clientid)).
10. Put the client ID and secret into the Backoffice configuration below with `environment` set to `sod` and connect an account of your SOD test tenant to try the connector.

### Move the application to Production

1. Pick up the client secret for Stage and Production **before** you request to publish: the request locks the configuration version.
2. On the application page select **Configuration** and click **Request to Publish**. SuperOffice creates a support ticket and runs certification (standard application) or validation (custom application). You can follow the request in **Messages**.
3. When the configuration is approved for Production, replace `clientId` and `clientSecret` in the Backoffice with the Production values and remove `environment` (or set it to `online`).
4. Each customer's administrator approves the application for their tenant — for a standard application on the SuperID consent screen (**I approve**), for a custom application through the activation request handled by SuperOffice Online Operations.

### Scopes

Scopes are not configured in the Developer Portal. The connector requests only `openid`; SuperOffice then gives the application access to the WebAPI of the user's tenant with that user's rights. **Make API Call** runs with the same access.

### Rate limits

The connector throttles itself to 10 requests per second per Appmixer user, following the SuperOffice validation checklist. The triggers (**New Company**, **New Person**, **New Sale**, **New Project**, **New Follow-up**) check SuperOffice for new records every minute; they do not need webhooks.

### Useful links

* [Building apps for SuperOffice](https://docs.superoffice.com/en/developer-portal/getting-started/index)
* [Register an application](https://docs.superoffice.com/en/developer-portal/create-app)
* [Redirects](https://docs.superoffice.com/en/developer-portal/create-app/config/redirects)
* [Application environments](https://docs.superoffice.com/en/developer-portal/getting-started/app-envir)
* [Request to publish](https://docs.superoffice.com/en/developer-portal/create-app/request-to-publish)

## Backoffice configuration

Configuration ID: `appmixer:superoffice` (Backoffice → Configuration; see [Connector Configuration](https://docs.appmixer.com/getting-started/services) for how a configuration is created and how its keys reach the connector).

* `clientId` — Client ID of the SuperOffice application registered above, for the environment set in `environment`.
* `clientSecret` — Client secret of the same application and environment.
* `environment` — Optional. The SuperOffice environment the connector signs in to: `online` (Production, default), `sod` (development) or `qaonline` (Stage). Client ID and secret must belong to the same environment. Any other value makes the connector fail.
* `listCacheTTL` — Optional. How long, in milliseconds, **List List Items** caches a SuperOffice list (it fills dropdowns such as **Category** and **Business** in the other components). Default `120000` (2 minutes).
* `outputFilePrefix` — Optional. File name prefix of the CSV file that **Find Companies**, **Find Persons**, **Find Sales**, **Find Projects**, **Find Follow-ups** and **List List Items** create when their output is set to *File*; the file is named `<prefix>-<component name>.csv`. Default `superoffice-objects-export`.

The same keys can be set with the CLI (`-u` updates the existing configuration instead of creating it):

```bash
appmixer service-config set appmixer:superoffice -u -d '{
  "clientId": "<client id>",
  "clientSecret": "<client secret>",
  "environment": "online"
}'
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.appmixer.com/connector-configuration/superoffice.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
