Skip to main content
​
Breaking changes - upgrade to version 2.3
  • All contributor responses now return contributors as an object with slug, tab, and contributor field objects.
  • All attachment responses now return a tab object for each attachment.
​
Version 2.3
  • Fixed response payload for comments in the assignments GET endpoints.
​
Version 2.3
  • Added endpoints for realtime applications.
​
Version 2.3
  • Added endpoints for listing and viewing action tasks.
  • Endpoint for creating an action task is now POST /action-task.
​
Version 2.3
  • Added items_array field to list and get order endpoints. Returns an array of objects for each order item.
​
Version 2.3
  • All application, user, and contributor date and date-time fields now accept ISO 8601 Zulu format.
  • All application, user, and contributor date and date-time fields now return values in ISO 8601 Zulu format.
​
Version 2.3
  • Allocation payment endpoints now support ISO 8601 Zulu format in date_due and date_paid fields.
  • Allocation payment endpoints now return dates and date-times in ISO 8601 Zulu format.
  • reference field now returns null when not provided, instead of ''.
​
Breaking changes - upgrade to version 2.2
  • All form fields in responses now return as an object with slug, name, and link fields.
  • All name and description fields now return as an object with translations for the requested language.
  • managers field in create, update, get, and list chapter endpoints now returns an array of manager objects with slug, first_name, last_name, and link fields.
  • Improved payload and response consistency for fields that use checkbox, date, or datetime types.
​
Version 2.2
  • Fixed scoreset name property to return translations.
​
Version 2.2
  • Added custom_deadline field in create, update, get, and list application endpoints.
​
Version 2.2
  • Added Get account endpoint.
​
Version 2.2
  • Added List rounds and Get round endpoints.
​
Version 2.2
  • Added URL filter to List webhooks and Get webhook endpoints.
  • Added signed_key to webhook endpoint responses.
​
Version 2.1
  • Added new status in allocation payment endpoints: failed_permanently.
​
Version 2.1
  • Added request example to create allocation payment endpoint: POST /allocation-payment.
​
Version 2.1
  • Added List documents endpoint.
  • Added Get document endpoint.
  • Added Create document endpoint.
  • Added Delete document endpoint.
​
Version 2.1
  • Added contributor endpoint for viewing, updating, and deleting contributors.
​
Version 2.1
  • Added List forms and Get form endpoints.
​
Version 2.1
  • Added List allocation payments endpoint.
  • Added Get allocation payment endpoint.
  • Added Create allocation payment endpoint.
  • Added Update allocation payment endpoint.
  • Added Delete allocation payment endpoint.
  • Added new subscription event types to List webhooks endpoint:
    • AllocationPaymentWasCreated
    • AllocationPaymentWasUpdated
    • AllocationPaymentWasDeleted
    • AllocationPaymentStatusWasChanged
    • AllocationWasCreated
​
Version 2.1
  • Added optional grant_status and grant_end_date fields to create and update application endpoints.
  • Added grant_status and grant_end_date to response object for list, create, update, and tag application endpoints.
  • Added grant status endpoints: List grant statuses and Get grant status.
​
Version 2.1
  • Added form slug to:
    • Query params and response body for List categories endpoint
    • Response body for Get category endpoint
    • Request body and response body for Create category endpoint
    • Response body for Update category endpoint
    • Query params and response body for List applications endpoint
    • Response body for Get applications endpoint
    • Request body and response body for Create applications endpoint
    • Response body for Update applications endpoint
    • Query params and response body for List fields endpoint
​
Version 2.1
  • Added List fields endpoint.
​
Breaking changes - upgrade to version 2.1
  • Added attachment endpoints for viewing, updating, and deleting attachments.
  • Changed name to filename in the response body for get attachment, list attachments, update attachment, get category, and get application endpoints.
  • Changed name to filename in the request body for upload application file, upload application attachment, upload chapter file, upload user file endpoints.
  • Grouped filename, token, download, and link under file in the response body for the upload application attachment and get application endpoints.
​
Version 2.0
  • Added webhooks.