Added
Adding Licenses API Endpoint
December 24th, 2025
Added a new /api/v1/licenses endpoint for managing License resources via the API.
Endpoints
GET /api/v1/licenses
List licenses with filtering, pagination, and relationship inclusion support.
Query Parameters:
external_identifier- Filter licenses by external identifier (also known as family ID)family_id- Alias forexternal_identifierparametercreated_start_date- Filter licenses created after the provided ISO8601 date/timecreated_end_date- Filter licenses created before the provided ISO8601 date/timeupdated_start_date- Filter licenses updated after the provided ISO8601 date/timeupdated_end_date- Filter licenses updated before the provided ISO8601 date/timepage[size]- Number of results per page (default: 20, max: 200)page[number]- Page number (default: 1)
Response Attributes:
id- License IDcreated-at- ISO8601 date/time when the license was createdupdated-at- ISO8601 date/time when the license was last updatedexternal-identifier- External system identifier for the licenseconfidential- Boolean indicating if this is a confidential caseexpiry-date- Expiry date of current approved Application (derived from next renewal cycle)tag-summary- Array of freeform tag nameslicense-type- Enum describing the type of licensesub-license-type- Enum listing the sub-license type if applicablecustom-field-values- Object mapping custom field slugs to their values
Relationships:
latest-application- The most recent Application associated with this License
GET /api/v1/licenses/:id
Get a specific license by ID.
Path Parameters:
license_id- Binti license ID
Response: Same structure as the index endpoint, but returns a single license object.
