List published frameworks

Prev Next
Get
/api/data/v1/frameworks/published

Use this endpoint to discover which pricing frameworks currently have an active published version. It’s the best starting point when you want to query pricing data but don’t yet know which frameworks are live and ready to read from.

What you get back
A list of frameworks that have an active published version. Each record includes the framework ID and its key details.

Security
HTTP
Type bearer

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

Responses
200

Frameworks with active published versions response

example
{
  "data": {
    "frameworks": [
      {
        "frameworkId": "11111111-1111",
        "name": "Pricing",
        "currentPublishedVersionId": "22222222-2222",
        "currentPublishedAt": "2025-01-01"
      }
    ]
  },
  "meta": {
    "requestId": "req-123"
  }
}
Expand All
object
data
object
frameworks
Array of object (FrameworkRecord)

A list of framework records.

object

A pricing framework that has an active published version and its key details like a unique ID, name, 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.

400

Validation error

validationError
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request",
    "requestId": "req-123",
    "details": {}
  }
}
Expand All
object
error
object (Error)
code
string
message
string
requestId
string
details
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