get/webhooksRead operation

Get all webhooks

Use the frozen API v0 contract to get all webhooks. Returns legacy response envelopes and uses page-and-limit pagination where the route supports collection reads. Authentication scopes the request to the workspace that issued the token.

Request example

curl --request GET \
  --url 'https://api.teamgrid.app/webhooks?page=PAGE&limit=LIMIT' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN'

const response = await fetch('https://api.teamgrid.app/webhooks?page=PAGE&limit=LIMIT', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.teamgrid.app/webhooks?page=PAGE&limit=LIMIT', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result: ApiResponse = await response.json()

Example response 2xx

{
  "data": null,
  "info": "string",
  "pagination": null,
  "status": null,
  "statusCode": 0
}

EndpointLegacy API

Query parameters

page

integer

One-based page number used by this legacy v0 collection endpoint.

limit

integer

Maximum number of records to return in this page. The response may contain fewer records.

Responses

200The legacy request to get all webhooks succeeded and returned the historical v0 response envelope.application/json

Response schemaapplication/json

data

object

Response data for the completed request.

info

string

The info associated with this legacy.

pagination

objectnullable

The pagination associated with this legacy.

status

stringnullable

Canonical status of the resource or operation.

statusCoderequired

integer

HTTP status code represented by this legacy response envelope.

201The legacy request to get all webhooks created a resource and returned the v0 response envelope.application/json

Response schemaapplication/json

data

object

Response data for the completed request.

info

string

The info associated with this legacy.

pagination

objectnullable

The pagination associated with this legacy.

status

stringnullable

Canonical status of the resource or operation.

statusCoderequired

integer

HTTP status code represented by this legacy response envelope.

204The request to get all webhooks completed successfully and returns no response body.

400Legacy request failure.application/json

Response schemaapplication/json

data

object

Response data for the completed request.

info

string

The info associated with this legacy.

pagination

objectnullable

The pagination associated with this legacy.

status

stringnullable

Canonical status of the resource or operation.

statusCoderequired

integer

HTTP status code represented by this legacy response envelope.

401Authentication failed.application/json

Response schemaapplication/json

error

string

Sanitized failure information when the operation did not succeed.

message

string

Human-readable explanation intended to help diagnose the result.

statusCoderequired

integer

HTTP status code represented by this legacy response envelope.

429Rate limit exceeded.application/json

Response schemaapplication/json

error

string

Sanitized failure information when the operation did not succeed.

message

string

Human-readable explanation intended to help diagnose the result.

statusCoderequired

integer

HTTP status code represented by this legacy response envelope.

Operation IDv0_get_webhooksOpenAPI JSON ↗

Documentation feedbackWas this page useful?