HTTP endpoints

listPlacements

GET /api/v1/placements

Requires read. Keep the Bearer key on your server.

SDK

grizzlee.listPlacements(): Promise<Placement[]>

HTTP

Use your backend's HTTP client. The cURL request shows the wire format. Replace path parameters and example values.

curl --fail-with-body --request GET \
  'https://app.grizzlee.ca/api/v1/placements' \
  -H "Authorization: Bearer $GRIZZLEE_SERVER_KEY"

Response

HTTP responses wrap this value in data. The SDK returns the value directly unless the note above describes a wrapper.

Type: array.

Response schema

json

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "key": {
        "type": "string"
      },
      "programId": {
        "type": "string"
      },
      "createdAt": {
        "type": "string"
      },
      "updatedAt": {
        "type": "string"
      }
    },
    "required": [
      "key",
      "programId",
      "createdAt",
      "updatedAt"
    ]
  }
}

Errors

Failures return { "error": { "code": "...", "message": "...", "details": {} } }. Details are optional. See error statuses. Reuse an unchanged event payload when retrying.