v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Scorecards

List all campaigns

Fetches all scorecard campaigns.

get/api/v2/scorecard/campaigns

Query parameters

page[limit]integer

Example:10

Maximum number of campaigns to return.

page[offset]integer

Offset for pagination.

filter[campaign][name]string

Example:security

Filter campaigns by name (full-text search).

filter[campaign][status]string

Example:in_progress

Filter campaigns by status.

filter[campaign][owner]string

Example:550e8400-e29b-41d4-a716-446655440000

Filter campaigns by owner UUID.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "created_at": "2023-12-15T10:30:00Z",
        "description": "Campaign to improve security posture for Q1 2024.",
        "due_date": "2024-03-31T23:59:59Z",
        "entity_scope": "kind:service AND team:platform",
        "guidance": "Please ensure all services pass the security requirements.",
        "key": "q1-security-2024",
        "modified_at": "2024-01-05T14:20:00Z",
        "name": "Q1 Security Campaign",
        "owner": "550e8400-e29b-41d4-a716-446655440000",
        "start_date": "2024-01-01T00:00:00Z",
        "status": "in_progress"
      },
      "id": "c10ODp0VCrrIpXmz",
      "type": "campaign"
    }
  ],
  "meta": {
    "count": 10,
    "limit": 10,
    "total": 150
  }
}