Reference · Credentials

KoBoToolbox API Token credentials

Used by 2 BusyBot nodes.

Type koBoToolboxApi 2 fields

The KoBoToolbox credential needs two values: the root URL of the KoBoToolbox server you use, and an API token from your account there. The URL matters because KoBoToolbox runs on several servers and self-hosted instances, each holding different data.

Fields

FieldTypeRequiredNotes
API Root URL
URL
string Yes The root URL of your KoBoToolbox instance.
API Token
token
password Yes Your KoBoToolbox API token.

Getting your credentials

  1. Sign in to the KoBoToolbox server your projects live on.
  2. Open your account settings and find the API token. Some deployments also expose it at the /token/?format=json path once signed in.
  3. Copy the token into the credential’s Token field.
  4. Set URL to the root URL of that same server — the host you signed in to. A self-hosted instance uses its own URL.

Permissions and scopes

The token acts as your user on that server, so it reaches the projects and submissions your account can see. It grants nothing on any other KoBoToolbox server.

Troubleshooting

  • 401 or 403 — the token belongs to a different server than the URL points at. The two must match.
  • Project not found — the account behind the token is not shared on that project.
  • Connection refused on self-hosted — the instance URL is wrong, or the server is not reachable from the workflow environment.

Frequently asked questions

Why do I have to supply a URL?

KoBoToolbox runs on several servers plus self-hosted instances, each with its own data and its own tokens. The token alone does not identify which one to call.

My token works in the browser but not here.

Check that the URL field points at the same server you were signed in to when you copied the token — a token is only valid on its own server.

Does one credential cover the node and the trigger?

Yes, both declare the same credential type.

Nodes that use KoBoToolbox API Token

One credential works across every node below — create it once and reuse it.

Last updated . Spotted something wrong? Tell us.