get/Read operation

Discover API v1

Use this operation to discover API v1. It returns public contract, version, regional endpoint, and capability metadata without requiring a credential.

Request example

curl --request GET \
  --url 'https://api.de.teamgrid.app/v1/' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN'

const response = await fetch('https://api.de.teamgrid.app/v1/', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result: ApiResponse = await response.json()

Example response 2xx

{
  "data": {
    "contractVersion": "string",
    "deprecations": [
      {
        "id": "string",
        "message": "string",
        "replacement": null,
        "sunsetAt": "2026-07-29T09:00:00.000Z"
      }
    ],
    "documentation": "string",
    "manifestSha256": "example",
    "region": null,
    "status": "string",
    "supportedClients": {
      "cli": {
        "minimumVersion": "string",
        "supportedMajor": 0
      },
      "mcp": {
        "minimumVersion": "string",
        "supportedMajor": 0
      },
      "sdk": {
        "minimumVersion": "string",
        "supportedMajor": 0
      }
    },
    "version": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Responses

200API version discovery.application/json

Response schemaapplication/json

required

object

Response data for the completed request.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDgetApiVersionOpenAPI JSON ↗

Documentation feedbackWas this page useful?