Skip to main content

List Agent Releases

GET /agent-releases

Returns a paginated list of published desktop agent releases.

Query Parameters

ParameterTypeDefaultDescription
channelstringstableRelease stream context: stable, latest
sort_bystringpublished_atSort field: version, published_at
sort_orderstringdescSort direction: asc, desc
page_sizeinteger50Items per page. Max: 200
cursorstring-Pagination cursor from a previous response

Response

FieldTypeDescription
dataAgentRelease[]Array of release objects
total_countintegerTotal number of releases matching the current filters
next_cursorstring | nullCursor to pass as cursor for the next page. null when on the last page.

Example Request

curl -X GET "https://api.example.com/v2/agent-releases" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Sort by version ascending

curl -X GET "https://api.example.com/v2/agent-releases?sort_by=version&sort_order=asc" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Example Response

{
"data": [
{
"channel": "stable",
"version": "1.8.3",
"published_at": "2026-02-24T21:23:53.082Z",
"notes_url": "https://github.com/Scalepad/scalepad-agent/releases/tag/v1.8.3",
"artifacts": {
"windows": {
"filename": "ScalepadAgent-1.8.3.msi",
"content_type": "application/octet-stream",
"size_bytes": 12345678,
"sha256": "abcdef1234567890",
"download_url": "/v2/agent-releases/1.8.3/download?platform=windows"
},
"macos": {
"arm64": {
"filename": "ScalepadAgent-1.8.3.pkg",
"content_type": "application/octet-stream",
"size_bytes": 23456789,
"sha256": "123456abcdef7890",
"download_url": "/v2/agent-releases/1.8.3/download?platform=macos&arch=arm64"
},
"x86_64": {
"filename": "ScalepadAgent-1.8.3.pkg",
"content_type": "application/octet-stream",
"size_bytes": 23456780,
"sha256": "7890abcdef123456",
"download_url": "/v2/agent-releases/1.8.3/download?platform=macos&arch=x86_64"
}
}
}
},
{
"channel": "stable",
"version": "1.8.2",
"published_at": "2026-02-10T18:00:00.000Z",
"notes_url": "https://github.com/Scalepad/scalepad-agent/releases/tag/v1.8.2",
"artifacts": {
"windows": {
"filename": "ScalepadAgent-1.8.2.msi",
"content_type": "application/octet-stream",
"size_bytes": 12340000,
"sha256": "fedcba0987654321",
"download_url": "/v2/agent-releases/1.8.2/download?platform=windows"
},
"macos": {
"arm64": {
"filename": "ScalepadAgent-1.8.2.pkg",
"content_type": "application/octet-stream",
"size_bytes": 23450000,
"sha256": "4567890abcdef123",
"download_url": "/v2/agent-releases/1.8.2/download?platform=macos&arch=arm64"
},
"x86_64": {
"filename": "ScalepadAgent-1.8.2.pkg",
"content_type": "application/octet-stream",
"size_bytes": 23440000,
"sha256": "321fedcba0987654",
"download_url": "/v2/agent-releases/1.8.2/download?platform=macos&arch=x86_64"
}
}
}
}
],
"total_count": 2,
"next_cursor": null
}

Empty Result

{
"data": [],
"total_count": 0,
"next_cursor": null
}

Pagination

This endpoint uses cursor-based pagination.

  1. Omit cursor on the first request
  2. If next_cursor is not null, pass its value as cursor on the next request
  3. Repeat until next_cursor is null

Error Responses

StatusDescription
400Invalid query parameters
401Authentication required
403Insufficient permissions
500Server error