API v1 overview

API v1 is the recommended contract for new TeamGrid integrations. It uses regional ingress, scoped reveal-once credentials, cursor pagination, idempotent creates, consistent errors, and signed webhook deliveries.

Base URL

The credential identifies its home region. Official clients derive the corresponding regional endpoint automatically:

https://api.<region>.teamgrid.app/v1

During the controlled beta, German credentials use:

https://api.de.teamgrid.app/v1

Do not send a bearer credential through a cross-region redirect. The target cell authenticates the full credential and rejects a region or cell mismatch.

Available resources

API v1 currently provides workspace, project, task, time-entry, contact, user, list, service, tag, audit-event, and webhook resources. Writes are intentionally limited to tasks, time entries, and signed webhooks.

Next steps

1. Create and protect a scoped credential.
2. Run the quickstart.
3. Choose the SDK or CLI if it fits your runtime.
4. Review pagination and idempotency before implementing synchronization or writes.