Initiatives

List initiatives

get

Paginated initiatives for the current user: personal initiatives by default, or team-scoped when team_id is set, or SESAR-code–scoped when sesar_code is set. Optional query filters by label, description, or funding (case-insensitive).

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

orderingstringOptional

Sort field; prefix with - for descending. Allowed: id, label, begin_date, end_date.

pageintegerOptional

Page number (1-based).

page_sizeintegerOptional

Items per page (max 2000).

querystringOptional

Substring filter on label, description, and funding.

sesar_codestringOptional

When set, scope list to initiatives for this SESAR code (view_initiative permission).

team_idintegerOptional

When set, list initiatives for this team (membership required).

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

get/api/initiatives/

GET /api/initiatives/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "count": 1,
      "next": "text",
      "previous": "text",
      "data": [
        {
          "id": 1,
          "label": "text",
          "description": "text",
          "funding": "text",
          "begin_date": "2026-01-01T00:00:00.000Z",
          "end_date": "2026-01-01T00:00:00.000Z",
          "initiative_uri": "text",
          "user_owner": 1,
          "team_owner": 1
        }
      ],
      "page_size": 1,
      "current_page": 1,
      "total_pages": 1
    }
  ]
}

Create initiative

post

Creates an initiative. Ownership determined by either: team_owner_id explicitly set in body, or defaults to the current user.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body

idintegerRead-onlyRequired

labelstring · max: 255Required

descriptionstring · nullableOptional

fundingstring · max: 50 · nullableOptional

begin_datestring · date-time · nullableOptional

end_datestring · date-time · nullableOptional

initiative_uristring · max: 255 · nullableOptional

user_ownerinteger · nullableOptional

team_ownerinteger · nullableOptional

Responses

201Success

application/json

post/api/initiatives/

POST /api/initiatives/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "label": "text",
  "description": "text",
  "funding": "text",
  "begin_date": "2026-01-01T00:00:00.000Z",
  "end_date": "2026-01-01T00:00:00.000Z",
  "initiative_uri": "text",
  "user_owner": 1,
  "team_owner": 1
}

201Success

{
  "data": {
    "id": 1,
    "label": "text",
    "description": "text",
    "funding": "text",
    "begin_date": "2026-01-01T00:00:00.000Z",
    "end_date": "2026-01-01T00:00:00.000Z",
    "initiative_uri": "text",
    "user_owner": 1,
    "team_owner": 1
  }
}

Retrieve initiative

get

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

Responses

200Success

application/json

get/api/initiatives/{id}/

GET /api/initiatives/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "id": 1,
    "label": "text",
    "description": "text",
    "funding": "text",
    "begin_date": "2026-01-01T00:00:00.000Z",
    "end_date": "2026-01-01T00:00:00.000Z",
    "initiative_uri": "text",
    "user_owner": 1,
    "team_owner": 1
  }
}

Delete initiative

delete

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

Responses

200Success

application/json

delete/api/initiatives/{id}/

DELETE /api/initiatives/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "success": true
  }
}

Update initiative

patch

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

Body

idintegerRead-onlyOptional

labelstring · max: 255Optional

descriptionstring · nullableOptional

fundingstring · max: 50 · nullableOptional

begin_datestring · date-time · nullableOptional

end_datestring · date-time · nullableOptional

initiative_uristring · max: 255 · nullableOptional

user_ownerinteger · nullableOptional

team_ownerinteger · nullableOptional

Responses

200Success

application/json

patch/api/initiatives/{id}/

PATCH /api/initiatives/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "label": "text",
  "description": "text",
  "funding": "text",
  "begin_date": "2026-01-01T00:00:00.000Z",
  "end_date": "2026-01-01T00:00:00.000Z",
  "initiative_uri": "text",
  "user_owner": 1,
  "team_owner": 1
}

200Success

{
  "data": {
    "id": 1,
    "label": "text",
    "description": "text",
    "funding": "text",
    "begin_date": "2026-01-01T00:00:00.000Z",
    "end_date": "2026-01-01T00:00:00.000Z",
    "initiative_uri": "text",
    "user_owner": 1,
    "team_owner": 1
  }
}