Catwise Takenbieb Partner API (CONCEPT) (1.0.0)

Download OpenAPI specification:

Catwise: support@catwise.nl

Universeel koppelvlak waarmee externe partners taken aanleveren aan de openbare Takenbieb van Catwise.

Werking op hoofdlijnen

Catwise stelt de koppeling in en verstrekt de partner OAuth2-credentials (client_id + client_secret).
De partner wisselt die via POST /oauth/token in voor een access token en kan daarna op elk moment taken aanmaken, bijwerken, verwijderen en opvragen.
Wijzigingen worden niet direct doorgevoerd. Elke mutatie (create/update/delete) komt eerst als verzoek in Catwise te staan en moet door een medewerker van Catwise worden geaccordeerd of afgekeurd:
- Create → New Item Request. Na akkoord komt de taak in de openbare Takenbieb te staan.
- Update → Change Request met per gewijzigd veld de oude en nieuwe waarde. Na akkoord wordt de wijziging doorgevoerd.
- Delete → Delete Request. Na akkoord wordt de taak verwijderd.
De partner ziet de stand van zaken via het read-only veld review_status (pending / approved / rejected) op elke taak. De interne Change/New-Item/Delete-Requests zelf zijn niet zichtbaar voor de partner.

Identifiers

id — door Catwise toegekend, stabiel, gebruikt in alle URL-paden.
external_id — de eigen referentie van de partner. Uniek per partner. Een tweede POST /task met een al bestaande external_id levert 409.

Authenticatie

OAuth 2.0 token-uitgifte.

Access token opvragen

Wisselt de client_id en client_secret (verstrekt door Catwise) in voor een access token via de OAuth 2.0 Client Credentials grant. Gebruik het teruggegeven token als Authorization: Bearer <access_token> bij alle overige endpoints. Vraag een nieuw token aan zodra het huidige is verlopen (expires_in).

De client-credentials mogen ook als HTTP Basic-header worden meegestuurd (Authorization: Basic base64(client_id:client_secret)) in plaats van in de body.

Request Body schema: application/x-www-form-urlencoded
required

grant_type required	string Value: "client_credentials"
client_id	string Door Catwise verstrekte client-id. Mag ook via HTTP Basic.
client_secret	string Door Catwise verstrekte client-secret. Mag ook via HTTP Basic.
scope	string Optioneel; spatie-gescheiden lijst van gevraagde scopes.

Responses

Response Schema: application/json

access_token	string
token_type	string
expires_in	integer Geldigheidsduur van het token in seconden.
scope	string Spatie-gescheiden lijst van toegekende scopes.

Response samples

Content type

application/json

{"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...",
"token_type": "Bearer",
"expires_in": 3600,
"scope": "tasks:read tasks:write"
}

Tasks

Beheer van eigen taken in de Takenbieb.

Taak aanmaken

Levert een nieuwe taak aan. Dit creëert intern een New Item Request. De respons bevat de aangemaakte taak met review_status: pending. De taak verschijnt pas in de openbare Takenbieb nadat Catwise het verzoek accordeert.

Authorizations:

oauth2

Request Body schema: application/json
required

external_id required	string <= 255 characters Eigen referentie van de partner. Uniek per partner.
status required	string (TaskStatus) Enum: "concept" "active" "inactive" Status van de taak bij de partner. `concept` — Concept `active` — Actief `inactive` — Niet Actief
source_updated_at	string <date-time> Tijdstip waarop de taak in het bronsysteem van de partner voor het laatst is bijgewerkt (veld 'Laatst bijgewerkt op').
access required	string (TaskAccess) Enum: "public" "private" Toegang tot de taak. `public` — Openbaar `private` — Besloten
template_name	string Naam van de template van de taak in de bieb.
teacher_instructions	string Instructie voor de docent (rich text / HTML toegestaan).
teacher_deeplink	string <uri> Deeplink voor de docent.
title required	string <= 255 characters Titel van de taak, zichtbaar voor de leerling.
banner_image_id	integer <int64> Id van een eerder via POST /attachments geüploade bijlage die als banner-image dient (zichtbaar voor de leerling).
description	string Omschrijving van de taak, zichtbaar voor de leerling.
student_deeplink	string <uri> Deeplink voor de leerling.
attachment_ids	Array of integers <int64> [ items <int64 > ] Id's van eerder via POST /attachments geüploade bijlagen die aan deze taak gekoppeld moeten worden.
subjects	Array of strings Vakken (inclusief 'Vakoverstijgend').
education_levels	Array of strings Jaarlagen / niveaus.
tag_ids	Array of integers <int64> [ items <int64 > ] Id's van tags / thema's (relatie public_portfolio_tags). Op te vragen bij Catwise.
skill_ids	Array of integers <int64> [ items <int64 > ] Id's van vaardigheden (relatie public_portfolio_skills). Op te vragen bij Catwise.

Responses

Response Schema: application/json

integer <int64>

Door Catwise toegekende identifier.

review_status

string (ReviewStatus)

Enum: "pending" "approved" "rejected"

Beoordelingsstatus van de laatste mutatie binnen Catwise.

pending — verzoek staat klaar voor beoordeling
approved — geaccordeerd en doorgevoerd
rejected — afgekeurd; de vorige geaccordeerde versie blijft van kracht

updated_at

string <date-time>

Tijdstip waarop deze representatie binnen Catwise voor het laatst is bijgewerkt.

object

De als banner-image gekoppelde afbeelding, opgelost naar een volledig object.

name	string Bestandsnaam van de afbeelding.
path	string Opslagpad binnen Catwise.
url	string <uri> (Tijdelijk getekende) URL om de afbeelding op te halen.

Array of objects (Tag)

De aan deze taak gekoppelde tags / thema's, opgelost naar volledige objecten.

Array

id	integer <int64>
name	string

Array of objects (Skill)

De aan deze taak gekoppelde vaardigheden, opgelost naar volledige objecten.

Array

id	integer <int64>
name	string
description	string

Array of objects (Attachment)

De aan deze taak gekoppelde bijlagen, opgelost naar volledige objecten.

Array

id	integer <int64> Door Catwise toegekende identifier van de bijlage.
url	string <uri> Catwise-gehoste URL van de bijlage.
name	string Weergavenaam van de bijlage.

external_id

required

string <= 255 characters

Eigen referentie van de partner. Uniek per partner.

status

required

string (TaskStatus)

Enum: "concept" "active" "inactive"

Status van de taak bij de partner.

concept — Concept
active — Actief
inactive — Niet Actief

source_updated_at

string <date-time>

Tijdstip waarop de taak in het bronsysteem van de partner voor het laatst is bijgewerkt (veld 'Laatst bijgewerkt op').

access

required

string (TaskAccess)

Enum: "public" "private"

Toegang tot de taak.

public — Openbaar
private — Besloten

template_name

string

Naam van de template van de taak in de bieb.

teacher_instructions

string

Instructie voor de docent (rich text / HTML toegestaan).

teacher_deeplink

string <uri>

Deeplink voor de docent.

title

required

string <= 255 characters

Titel van de taak, zichtbaar voor de leerling.

banner_image_id

integer <int64>

Id van een eerder via POST /attachments geüploade bijlage die als banner-image dient (zichtbaar voor de leerling).

description

string

Omschrijving van de taak, zichtbaar voor de leerling.

student_deeplink

string <uri>

Deeplink voor de leerling.

attachment_ids

Array of integers <int64> [ items <int64 > ]

Id's van eerder via POST /attachments geüploade bijlagen die aan deze taak gekoppeld moeten worden.

subjects

Array of strings

Vakken (inclusief 'Vakoverstijgend').

education_levels

Array of strings

Jaarlagen / niveaus.

tag_ids

Array of integers <int64> [ items <int64 > ]

Id's van tags / thema's (relatie public_portfolio_tags). Op te vragen bij Catwise.

skill_ids

Array of integers <int64> [ items <int64 > ]

Id's van vaardigheden (relatie public_portfolio_skills). Op te vragen bij Catwise.

Request samples

Payload

Content type

application/json

{"external_id": "REF1",
"status": "active",
"source_updated_at": "2026-06-25T09:30:00+02:00",
"access": "public",
"template_name": "Reflectieopdracht",
"teacher_instructions": "Bespreek de opdracht klassikaal voor aanvang.",
"teacher_deeplink": "https://partner.example/teacher/REF1",
"title": "taak1",
"banner_image_id": 41,
"description": "In deze taak reflecteer je op je samenwerking.",
"student_deeplink": "https://partner.example/student/REF1",
"attachment_ids": [42,
43
],
"subjects": ["Biologie",
"Duits",
"Economie"
],
"education_levels": ["Havo 4",
"Havo 5",
"VWO 4",
"VWO 6"
],
"tag_ids": [3,
7
],
"skill_ids": [12,
15
]
}

Response samples

Content type

application/json

{"id": 1,
"review_status": "pending",
"updated_at": "2026-06-25T07:31:00Z",
"banner_image": {"name": "REF1.jpg",
"path": "public-portfolio-tasks/1/banner/REF1.jpg",
"url": "https://api.catwise.nl/partner/v1/tasks/1/banner?signature=..."
},
"tags": [{"id": 3,
"name": "LOB"
}
],
"skills": [{"id": 12,
"name": "Samenwerken",
"description": "Effectief samenwerken in een team."
}
],
"attachments": [{"id": 42,
"url": "https://cdn.catwise.nl/attachments/42",
"name": "Opdrachtomschrijving.pdf"
}
],
"external_id": "REF1",
"status": "active",
"source_updated_at": "2026-06-25T09:30:00+02:00",
"access": "public",
"template_name": "Reflectieopdracht",
"teacher_instructions": "Bespreek de opdracht klassikaal voor aanvang.",
"teacher_deeplink": "https://partner.example/teacher/REF1",
"title": "taak1",
"banner_image_id": 41,
"description": "In deze taak reflecteer je op je samenwerking.",
"student_deeplink": "https://partner.example/student/REF1",
"attachment_ids": [42,
43
],
"subjects": ["Biologie",
"Duits",
"Economie"
],
"education_levels": ["Havo 4",
"Havo 5",
"VWO 4",
"VWO 6"
],
"tag_ids": [3,
7
],
"skill_ids": [12,
15
]
}

Eén taak opvragen

Authorizations:

oauth2

path Parameters

required

integer <int64>

Examples: 1

De door Catwise toegekende identifier van de taak.

Responses

Response Schema: application/json

integer <int64>

Door Catwise toegekende identifier.

review_status

string (ReviewStatus)

Enum: "pending" "approved" "rejected"

Beoordelingsstatus van de laatste mutatie binnen Catwise.

pending — verzoek staat klaar voor beoordeling
approved — geaccordeerd en doorgevoerd
rejected — afgekeurd; de vorige geaccordeerde versie blijft van kracht

updated_at

string <date-time>

Tijdstip waarop deze representatie binnen Catwise voor het laatst is bijgewerkt.

object

De als banner-image gekoppelde afbeelding, opgelost naar een volledig object.

name	string Bestandsnaam van de afbeelding.
path	string Opslagpad binnen Catwise.
url	string <uri> (Tijdelijk getekende) URL om de afbeelding op te halen.

Array of objects (Tag)

De aan deze taak gekoppelde tags / thema's, opgelost naar volledige objecten.

Array

id	integer <int64>
name	string

Array of objects (Skill)

De aan deze taak gekoppelde vaardigheden, opgelost naar volledige objecten.

Array

id	integer <int64>
name	string
description	string

Array of objects (Attachment)

De aan deze taak gekoppelde bijlagen, opgelost naar volledige objecten.

Array

id	integer <int64> Door Catwise toegekende identifier van de bijlage.
url	string <uri> Catwise-gehoste URL van de bijlage.
name	string Weergavenaam van de bijlage.

external_id

required

string <= 255 characters

Eigen referentie van de partner. Uniek per partner.

status

required

string (TaskStatus)

Enum: "concept" "active" "inactive"

Status van de taak bij de partner.

concept — Concept
active — Actief
inactive — Niet Actief

source_updated_at

string <date-time>

Tijdstip waarop de taak in het bronsysteem van de partner voor het laatst is bijgewerkt (veld 'Laatst bijgewerkt op').

access

required

string (TaskAccess)

Enum: "public" "private"

Toegang tot de taak.

public — Openbaar
private — Besloten

template_name

string

Naam van de template van de taak in de bieb.

teacher_instructions

string

Instructie voor de docent (rich text / HTML toegestaan).

teacher_deeplink

string <uri>

Deeplink voor de docent.

title

required

string <= 255 characters

Titel van de taak, zichtbaar voor de leerling.

banner_image_id

integer <int64>

Id van een eerder via POST /attachments geüploade bijlage die als banner-image dient (zichtbaar voor de leerling).

description

string

Omschrijving van de taak, zichtbaar voor de leerling.

student_deeplink

string <uri>

Deeplink voor de leerling.

attachment_ids

Array of integers <int64> [ items <int64 > ]

Id's van eerder via POST /attachments geüploade bijlagen die aan deze taak gekoppeld moeten worden.

subjects

Array of strings

Vakken (inclusief 'Vakoverstijgend').

education_levels

Array of strings

Jaarlagen / niveaus.

tag_ids

Array of integers <int64> [ items <int64 > ]

Id's van tags / thema's (relatie public_portfolio_tags). Op te vragen bij Catwise.

skill_ids

Array of integers <int64> [ items <int64 > ]

Id's van vaardigheden (relatie public_portfolio_skills). Op te vragen bij Catwise.

Response samples

Content type

application/json

{"id": 1,
"review_status": "pending",
"updated_at": "2026-06-25T07:31:00Z",
"banner_image": {"name": "REF1.jpg",
"path": "public-portfolio-tasks/1/banner/REF1.jpg",
"url": "https://api.catwise.nl/partner/v1/tasks/1/banner?signature=..."
},
"tags": [{"id": 3,
"name": "LOB"
}
],
"skills": [{"id": 12,
"name": "Samenwerken",
"description": "Effectief samenwerken in een team."
}
],
"attachments": [{"id": 42,
"url": "https://cdn.catwise.nl/attachments/42",
"name": "Opdrachtomschrijving.pdf"
}
],
"external_id": "REF1",
"status": "active",
"source_updated_at": "2026-06-25T09:30:00+02:00",
"access": "public",
"template_name": "Reflectieopdracht",
"teacher_instructions": "Bespreek de opdracht klassikaal voor aanvang.",
"teacher_deeplink": "https://partner.example/teacher/REF1",
"title": "taak1",
"banner_image_id": 41,
"description": "In deze taak reflecteer je op je samenwerking.",
"student_deeplink": "https://partner.example/student/REF1",
"attachment_ids": [42,
43
],
"subjects": ["Biologie",
"Duits",
"Economie"
],
"education_levels": ["Havo 4",
"Havo 5",
"VWO 4",
"VWO 6"
],
"tag_ids": [3,
7
],
"skill_ids": [12,
15
]
}

Taak bijwerken

Stuur de volledige gewenste representatie van de taak. Catwise vergelijkt deze met de huidige taak en maakt een Change Request aan met per gewijzigd veld de oude en nieuwe waarde. De wijziging wordt pas doorgevoerd na akkoord; tot die tijd toont de taak review_status: pending.

Authorizations:

oauth2

path Parameters

required

integer <int64>

Examples: 1

De door Catwise toegekende identifier van de taak.

Request Body schema: application/json
required

external_id required	string <= 255 characters Eigen referentie van de partner. Uniek per partner.
status required	string (TaskStatus) Enum: "concept" "active" "inactive" Status van de taak bij de partner. `concept` — Concept `active` — Actief `inactive` — Niet Actief
source_updated_at	string <date-time> Tijdstip waarop de taak in het bronsysteem van de partner voor het laatst is bijgewerkt (veld 'Laatst bijgewerkt op').
access required	string (TaskAccess) Enum: "public" "private" Toegang tot de taak. `public` — Openbaar `private` — Besloten
template_name	string Naam van de template van de taak in de bieb.
teacher_instructions	string Instructie voor de docent (rich text / HTML toegestaan).
teacher_deeplink	string <uri> Deeplink voor de docent.
title required	string <= 255 characters Titel van de taak, zichtbaar voor de leerling.
banner_image_id	integer <int64> Id van een eerder via POST /attachments geüploade bijlage die als banner-image dient (zichtbaar voor de leerling).
description	string Omschrijving van de taak, zichtbaar voor de leerling.
student_deeplink	string <uri> Deeplink voor de leerling.
attachment_ids	Array of integers <int64> [ items <int64 > ] Id's van eerder via POST /attachments geüploade bijlagen die aan deze taak gekoppeld moeten worden.
subjects	Array of strings Vakken (inclusief 'Vakoverstijgend').
education_levels	Array of strings Jaarlagen / niveaus.
tag_ids	Array of integers <int64> [ items <int64 > ] Id's van tags / thema's (relatie public_portfolio_tags). Op te vragen bij Catwise.
skill_ids	Array of integers <int64> [ items <int64 > ] Id's van vaardigheden (relatie public_portfolio_skills). Op te vragen bij Catwise.

Responses

Response Schema: application/json

integer <int64>

Door Catwise toegekende identifier.

review_status

string (ReviewStatus)

Enum: "pending" "approved" "rejected"

Beoordelingsstatus van de laatste mutatie binnen Catwise.

pending — verzoek staat klaar voor beoordeling
approved — geaccordeerd en doorgevoerd
rejected — afgekeurd; de vorige geaccordeerde versie blijft van kracht

updated_at

string <date-time>

Tijdstip waarop deze representatie binnen Catwise voor het laatst is bijgewerkt.

object

De als banner-image gekoppelde afbeelding, opgelost naar een volledig object.

name	string Bestandsnaam van de afbeelding.
path	string Opslagpad binnen Catwise.
url	string <uri> (Tijdelijk getekende) URL om de afbeelding op te halen.

Array of objects (Tag)

De aan deze taak gekoppelde tags / thema's, opgelost naar volledige objecten.

Array

id	integer <int64>
name	string

Array of objects (Skill)

De aan deze taak gekoppelde vaardigheden, opgelost naar volledige objecten.

Array

id	integer <int64>
name	string
description	string

Array of objects (Attachment)

De aan deze taak gekoppelde bijlagen, opgelost naar volledige objecten.

Array

id	integer <int64> Door Catwise toegekende identifier van de bijlage.
url	string <uri> Catwise-gehoste URL van de bijlage.
name	string Weergavenaam van de bijlage.

external_id

required

string <= 255 characters

Eigen referentie van de partner. Uniek per partner.

status

required

string (TaskStatus)

Enum: "concept" "active" "inactive"

Status van de taak bij de partner.

concept — Concept
active — Actief
inactive — Niet Actief

source_updated_at

string <date-time>

Tijdstip waarop de taak in het bronsysteem van de partner voor het laatst is bijgewerkt (veld 'Laatst bijgewerkt op').

access

required

string (TaskAccess)

Enum: "public" "private"

Toegang tot de taak.

public — Openbaar
private — Besloten

template_name

string

Naam van de template van de taak in de bieb.

teacher_instructions

string

Instructie voor de docent (rich text / HTML toegestaan).

teacher_deeplink

string <uri>

Deeplink voor de docent.

title

required

string <= 255 characters

Titel van de taak, zichtbaar voor de leerling.

banner_image_id

integer <int64>

Id van een eerder via POST /attachments geüploade bijlage die als banner-image dient (zichtbaar voor de leerling).

description

string

Omschrijving van de taak, zichtbaar voor de leerling.

student_deeplink

string <uri>

Deeplink voor de leerling.

attachment_ids

Array of integers <int64> [ items <int64 > ]

Id's van eerder via POST /attachments geüploade bijlagen die aan deze taak gekoppeld moeten worden.

subjects

Array of strings

Vakken (inclusief 'Vakoverstijgend').

education_levels

Array of strings

Jaarlagen / niveaus.

tag_ids

Array of integers <int64> [ items <int64 > ]

Id's van tags / thema's (relatie public_portfolio_tags). Op te vragen bij Catwise.

skill_ids

Array of integers <int64> [ items <int64 > ]

Id's van vaardigheden (relatie public_portfolio_skills). Op te vragen bij Catwise.

Request samples

Payload

Content type

application/json

{"external_id": "REF1",
"status": "active",
"source_updated_at": "2026-06-25T09:30:00+02:00",
"access": "public",
"template_name": "Reflectieopdracht",
"teacher_instructions": "Bespreek de opdracht klassikaal voor aanvang.",
"teacher_deeplink": "https://partner.example/teacher/REF1",
"title": "taak1",
"banner_image_id": 41,
"description": "In deze taak reflecteer je op je samenwerking.",
"student_deeplink": "https://partner.example/student/REF1",
"attachment_ids": [42,
43
],
"subjects": ["Biologie",
"Duits",
"Economie"
],
"education_levels": ["Havo 4",
"Havo 5",
"VWO 4",
"VWO 6"
],
"tag_ids": [3,
7
],
"skill_ids": [12,
15
]
}

Response samples

Content type

application/json

{"id": 1,
"review_status": "pending",
"updated_at": "2026-06-25T07:31:00Z",
"banner_image": {"name": "REF1.jpg",
"path": "public-portfolio-tasks/1/banner/REF1.jpg",
"url": "https://api.catwise.nl/partner/v1/tasks/1/banner?signature=..."
},
"tags": [{"id": 3,
"name": "LOB"
}
],
"skills": [{"id": 12,
"name": "Samenwerken",
"description": "Effectief samenwerken in een team."
}
],
"attachments": [{"id": 42,
"url": "https://cdn.catwise.nl/attachments/42",
"name": "Opdrachtomschrijving.pdf"
}
],
"external_id": "REF1",
"status": "active",
"source_updated_at": "2026-06-25T09:30:00+02:00",
"access": "public",
"template_name": "Reflectieopdracht",
"teacher_instructions": "Bespreek de opdracht klassikaal voor aanvang.",
"teacher_deeplink": "https://partner.example/teacher/REF1",
"title": "taak1",
"banner_image_id": 41,
"description": "In deze taak reflecteer je op je samenwerking.",
"student_deeplink": "https://partner.example/student/REF1",
"attachment_ids": [42,
43
],
"subjects": ["Biologie",
"Duits",
"Economie"
],
"education_levels": ["Havo 4",
"Havo 5",
"VWO 4",
"VWO 6"
],
"tag_ids": [3,
7
],
"skill_ids": [12,
15
]
}

Taak verwijderen

Maakt een Delete Request aan. De taak blijft bestaan met review_status: pending totdat Catwise het verzoek accordeert; daarna wordt de taak verwijderd.

Authorizations:

oauth2

path Parameters

required

integer <int64>

Examples: 1

De door Catwise toegekende identifier van de taak.

Responses

Response samples

Content type

application/json

{"id": 1,
"review_status": "pending",
"updated_at": "2026-06-25T07:31:00Z",
"banner_image": {"name": "REF1.jpg",
"path": "public-portfolio-tasks/1/banner/REF1.jpg",
"url": "https://api.catwise.nl/partner/v1/tasks/1/banner?signature=..."
},
"tags": [{"id": 3,
"name": "LOB"
}
],
"skills": [{"id": 12,
"name": "Samenwerken",
"description": "Effectief samenwerken in een team."
}
],
"attachments": [{"id": 42,
"url": "https://cdn.catwise.nl/attachments/42",
"name": "Opdrachtomschrijving.pdf"
}
],
"external_id": "REF1",
"status": "active",
"source_updated_at": "2026-06-25T09:30:00+02:00",
"access": "public",
"template_name": "Reflectieopdracht",
"teacher_instructions": "Bespreek de opdracht klassikaal voor aanvang.",
"teacher_deeplink": "https://partner.example/teacher/REF1",
"title": "taak1",
"banner_image_id": 41,
"description": "In deze taak reflecteer je op je samenwerking.",
"student_deeplink": "https://partner.example/student/REF1",
"attachment_ids": [42,
43
],
"subjects": ["Biologie",
"Duits",
"Economie"
],
"education_levels": ["Havo 4",
"Havo 5",
"VWO 4",
"VWO 6"
],
"tag_ids": [3,
7
],
"skill_ids": [12,
15
]
}

Lijst van eigen taken

Geeft alle taken die door deze partner zijn aangeleverd, als array.

Authorizations:

oauth2

query Parameters

status	string (TaskStatus) Enum: "concept" "active" "inactive" Examples: status=active Filter op de status van de taak.
review_status	string (ReviewStatus) Enum: "pending" "approved" "rejected" Examples: review_status=pending Filter op de beoordelingsstatus binnen Catwise.

Responses

Response Schema: application/json

Array

integer <int64>

Door Catwise toegekende identifier.

review_status

string (ReviewStatus)

Enum: "pending" "approved" "rejected"

Beoordelingsstatus van de laatste mutatie binnen Catwise.

pending — verzoek staat klaar voor beoordeling
approved — geaccordeerd en doorgevoerd
rejected — afgekeurd; de vorige geaccordeerde versie blijft van kracht

updated_at

string <date-time>

Tijdstip waarop deze representatie binnen Catwise voor het laatst is bijgewerkt.

object

De als banner-image gekoppelde afbeelding, opgelost naar een volledig object.

name	string Bestandsnaam van de afbeelding.
path	string Opslagpad binnen Catwise.
url	string <uri> (Tijdelijk getekende) URL om de afbeelding op te halen.

Array of objects (Tag)

De aan deze taak gekoppelde tags / thema's, opgelost naar volledige objecten.

Array

id	integer <int64>
name	string

Array of objects (Skill)

De aan deze taak gekoppelde vaardigheden, opgelost naar volledige objecten.

Array

id	integer <int64>
name	string
description	string

Array of objects (Attachment)

De aan deze taak gekoppelde bijlagen, opgelost naar volledige objecten.

Array

id	integer <int64> Door Catwise toegekende identifier van de bijlage.
url	string <uri> Catwise-gehoste URL van de bijlage.
name	string Weergavenaam van de bijlage.

external_id

required

string <= 255 characters

Eigen referentie van de partner. Uniek per partner.

status

required

string (TaskStatus)

Enum: "concept" "active" "inactive"

Status van de taak bij de partner.

concept — Concept
active — Actief
inactive — Niet Actief

source_updated_at

string <date-time>

Tijdstip waarop de taak in het bronsysteem van de partner voor het laatst is bijgewerkt (veld 'Laatst bijgewerkt op').

access

required

string (TaskAccess)

Enum: "public" "private"

Toegang tot de taak.

public — Openbaar
private — Besloten

template_name

string

Naam van de template van de taak in de bieb.

teacher_instructions

string

Instructie voor de docent (rich text / HTML toegestaan).

teacher_deeplink

string <uri>

Deeplink voor de docent.

title

required

string <= 255 characters

Titel van de taak, zichtbaar voor de leerling.

banner_image_id

integer <int64>

Id van een eerder via POST /attachments geüploade bijlage die als banner-image dient (zichtbaar voor de leerling).

description

string

Omschrijving van de taak, zichtbaar voor de leerling.

student_deeplink

string <uri>

Deeplink voor de leerling.

attachment_ids

Array of integers <int64> [ items <int64 > ]

Id's van eerder via POST /attachments geüploade bijlagen die aan deze taak gekoppeld moeten worden.

subjects

Array of strings

Vakken (inclusief 'Vakoverstijgend').

education_levels

Array of strings

Jaarlagen / niveaus.

tag_ids

Array of integers <int64> [ items <int64 > ]

Id's van tags / thema's (relatie public_portfolio_tags). Op te vragen bij Catwise.

skill_ids

Array of integers <int64> [ items <int64 > ]

Id's van vaardigheden (relatie public_portfolio_skills). Op te vragen bij Catwise.

Response samples

Content type

application/json

[{"id": 1,
"review_status": "pending",
"updated_at": "2026-06-25T07:31:00Z",
"banner_image": {"name": "REF1.jpg",
"path": "public-portfolio-tasks/1/banner/REF1.jpg",
"url": "https://api.catwise.nl/partner/v1/tasks/1/banner?signature=..."
},
"tags": [{"id": null,
"name": null
}
],
"skills": [{"id": null,
"name": null,
"description": null
}
],
"attachments": [{"id": null,
"url": null,
"name": null
}
],
"external_id": "REF1",
"status": "active",
"source_updated_at": "2026-06-25T09:30:00+02:00",
"access": "public",
"template_name": "Reflectieopdracht",
"teacher_instructions": "Bespreek de opdracht klassikaal voor aanvang.",
"teacher_deeplink": "https://partner.example/teacher/REF1",
"title": "taak1",
"banner_image_id": 41,
"description": "In deze taak reflecteer je op je samenwerking.",
"student_deeplink": "https://partner.example/student/REF1",
"attachment_ids": [42,
43
],
"subjects": ["Biologie",
"Duits",
"Economie"
],
"education_levels": ["Havo 4",
"Havo 5",
"VWO 4",
"VWO 6"
],
"tag_ids": [3,
7
],
"skill_ids": [12,
15
]
}
]

Bijlagen

Upload van bestanden die als bijlage aan een taak worden gekoppeld.

Bijlage uploaden

Uploadt een bestand naar Catwise. De respons bevat een Attachment met een door Catwise toegekend id en een Catwise-gehoste url.

Het uploaden zelf wordt direct verwerkt en hoeft niet te worden geaccordeerd. De bijlage wordt pas onderdeel van een taak — en daarmee zichtbaar in de openbare Takenbieb — zodra het id wordt opgenomen in attachment_ids van een taak én de bijbehorende New Item / Change Request is geaccordeerd. Een geüploade bijlage die nergens aan gekoppeld is, kan door Catwise worden opgeruimd.

Authorizations:

oauth2

Request Body schema: multipart/form-data
required

file required	string <binary> Het te uploaden bestand.
name	string Optionele weergavenaam; standaard de bestandsnaam.

Responses

Response Schema: application/json

id	integer <int64> Door Catwise toegekende identifier van de bijlage.
url	string <uri> Catwise-gehoste URL van de bijlage.
name	string Weergavenaam van de bijlage.

Response samples

Content type

application/json

{"id": 42,
"url": "https://cdn.catwise.nl/attachments/42",
"name": "Opdrachtomschrijving.pdf"
}

Catwise Takenbieb Partner API (CONCEPT) (1.0.0)

Werking op hoofdlijnen

Identifiers

Authenticatie

Access token opvragen

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response Schema: application/json

Response samples

Tasks

Taak aanmaken

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Eén taak opvragen

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Taak bijwerken

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Taak verwijderen

Authorizations:

path Parameters

Responses

Response samples

Lijst van eigen taken

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Bijlagen

Bijlage uploaden

Authorizations:

Request Body schema: multipart/form-datarequired

Responses

Response Schema: application/json

Response samples

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required