Skip to content

API v1 quickstart

In TeamGrid, open Settings → Team → Developer, choose API v1, select the minimum required scopes, and create a credential.

The secret is shown once. Store it in an OS keychain or secret manager. Do not place it in source control, command history, URLs, or logs.

Set the credential only for the current process and call the regional endpoint encoded by the credential:

Terminal window
export TEAMGRID_API_TOKEN='your-reveal-once-credential'
curl --fail-with-body \
--header "Authorization: Bearer $TEAMGRID_API_TOKEN" \
--header 'Accept: application/json' \
https://api.de.teamgrid.app/v1/workspace

The response identifies the authenticated workspace and its region and cell. A credential never selects another workspace through a request parameter.

Terminal window
curl --fail-with-body \
--header "Authorization: Bearer $TEAMGRID_API_TOKEN" \
--header 'Accept: application/json' \
'https://api.de.teamgrid.app/v1/tasks?limit=25'

Use meta.page.nextCursor to request the next page. Treat cursors as opaque strings.

4. Prefer an official client when possible

Section titled “4. Prefer an official client when possible”

For Node.js applications, continue with the TypeScript SDK quickstart. For shell scripts or local operation, use the CLI.