Skip to content
Developer docs
⌘ K
Dashboard ↗

HTTP endpoints

getPlacement

GET /api/v1/placements/{key}

Requires read. Keep the Bearer key on your server.

SDK

ts
grizzlee.getPlacement(key: string): Promise<Placement>

HTTP

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

sh
curl --fail-with-body --request GET \
  'https://app.grizzlee.ca/api/v1/placements/{key}' \
  -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.

FieldTypeRequiredDetails
keystringYes
programIdstringYes
createdAtstringYes
updatedAtstringYes

Response schema

json
{
  "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.