Start building with TeamGrid

What you need

Use a workspace in which you are allowed to create developer credentials. Decide first whether the integration runs on behalf of one person or as a long-lived service account. That choice determines who owns the credential and how it should be rotated.

Keep the credential in a secret manager. TeamGrid reveals its secret once and the official clients derive the correct regional endpoint from the credential.

1. Confirm the platform

Call the workspace endpoint before working with business data:

curl --fail-with-body \
  --header "Authorization: Bearer $TEAMGRID_API_TOKEN" \
  --header "Accept: application/json" \
  https://api.de.teamgrid.app/v1/workspace

A successful response confirms the credential, region and API version. A 401 means the token cannot authenticate. A 403 means it authenticated but lacks the required scope.

2. Read before you write

Start with one bounded list request, such as GET /projects?limit=25. Store the returned IDs unchanged. TeamGrid identifiers are opaque and must not be parsed or generated by clients.

For updates, read the resource first and retain its strong ETag or developer revision. Send that value with the following write so another change cannot be overwritten silently.

3. Make writes repeatable

Use a stable idempotency key for create operations and domain actions. Reusing the same key with the same request lets a retry return the original result. Reusing it with a different request is an error.

4. Prepare for operation

Before enabling the integration for customers:

• cap request timeouts and retries;
• record TeamGrid request IDs without recording bearer tokens;
• handle 409, 412 and 429 explicitly;
• verify webhook signatures before parsing payloads;
• monitor the TeamGrid status page;
• keep a tested credential-revocation path.

Continue with the API v1 quickstart for request details or choose an interface before implementing the client.