List published versions for a framework

Prev Next
Get
/api/data/v1/frameworks/{frameworkId}/versions

Use this endpoint to retrieve the list of published versions for a specific pricing framework. It helps you understand the framework’s publication history and gives you the exact frameworkVersionId values you can use to run version-pinned queries.

What you get back
A list of published versions for the framework. Each record includes the framework version ID and its key details.

Security
HTTP
Type bearer

Enter an access token to authenticate your requests. For details, read Get an access token.

Path parameters
frameworkId
string (uuid) Required

Framework identifier.

Responses
200

Published versions of a framework response

example
{
  "data": {
    "versions": [
      {
        "frameworkVersionId": "22222222-2222",
        "frameworkId": "11111111-1111",
        "PublishedAt": "2025-01-01"
      }
    ]
  },
  "meta": {
    "requestId": "req-123"
  }
}
Expand All
object
data
object
versions
Array of object (FrameworkVersionRecord)

A list of published versions of a framework.

object

A published framework version and its key details like a unique ID and publication date.

pagination
object (Pagination)

Results pagination details.

cursor
string | null

Cursor for pagination.

hasMore
boolean

True if more records are available.

meta
object
requestId
string

Request identifier for tracing.

401

Unauthorized

unauthorized
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Unauthorized",
    "requestId": "req-123"
  }
}
Expand All
object
error
object (Error)
code
string
message
string
requestId
string
details
403

Forbidden

forbidden
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Forbidden",
    "requestId": "req-123"
  }
}
Expand All
object
error
object (Error)
code
string
message
string
requestId
string
details
404

Queried element not found

notFound
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found",
    "requestId": "req-123"
  }
}
Expand All
object
error
object (Error)
code
string
message
string
requestId
string
details
500

Internal error

internalError
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal error",
    "requestId": "req-123"
  }
}
Expand All
object
error
object (Error)
code
string
message
string
requestId
string
details
502

Upstream error

upstreamError
{
  "error": {
    "code": "UPSTREAM_ERROR",
    "message": "Upstream dependency failed",
    "requestId": "req-123"
  }
}
Expand All
object
error
object (Error)
code
string
message
string
requestId
string
details