Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiProvider-backed

Get radar credits

GET /api/radar/credits

Read the selected workspace Radar credit balance. Pipeline BYOK operations are separate.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

workspace_id

string

Workspace UUID

Example

REST requestbash

curl -X GET "https://app.pipeline.help/api/radar/credits" \
  -H "Authorization: Bearer $PIPELINE_API_KEY"

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "balance": {
      "type": "number"
    },
    "unit": {
      "type": "string"
    }
  },
  "required": [
    "balance",
    "unit"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.