post/searchWrite operation

Search authorized TeamGrid resources

Searches only the requested, scope-authorized product domains in the owning cell. Results are bounded, metadata-only, tenant-filtered and sharing-filtered. meta.search.complete is always false: even a short or empty index result does not prove completeness. Narrow ambiguous searches or use resource list pagination for complete reports. Verify recent writes by their returned IDs because indexing can lag.

Required scopes

search:read

Conditional scopes

contacts:readprojects:readtasks:read

Request example

curl --request POST \
  --url 'https://api.de.teamgrid.app/v1/search' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "limit": 1,
    "term": "string",
    "types": [
      "contacts"
    ]
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/search', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "limit": 1,
  "term": "string",
  "types": [
    "contacts"
  ]
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/search', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "limit": 1,
  "term": "string",
  "types": [
    "contacts"
  ]
}),
})

const result: ApiResponse = await response.json()

teamgrid search create \
  --data @payload.json

Example response 2xx

{
  "data": [
    "SearchResult"
  ],
  "meta": {
    "requestId": "string",
    "search": {
      "complete": null,
      "indexed": null,
      "limit": 1,
      "returned": 0,
      "continuation": null,
      "verification": null
    }
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

X-TeamGrid-Response-Featuresheader

JSON request bodyValid JSON

Generated cURL

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

Headers

X-TeamGrid-Response-Features

string

Opt in to explicit bounded-search metadata. Omitted for compatibility with older strict SDK response validators.

Request body

application/json

limit

integer

Maximum number of records requested or returned for this page.

termrequired

string

The term associated with this search request.

typesrequired

array<string>

The types associated with this search request.

contactsprojectstasks

Responses

200At most 50 authorized search results.application/json

Response schemaapplication/json

required

array<SearchResult>

Public API representation of search result.

required

SearchResponseMeta

Public API representation of search meta.

400The request is invalid.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.

401The bearer credential is missing, invalid, expired, or revoked.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.

403The credential has insufficient scope.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.

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.

502The cell-local application returned an invalid response.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.

503A required cell-local dependency is unavailable.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 IDsearchResourcesOpenAPI JSON ↗

Documentation feedbackWas this page useful?