Skip to main content
GET
/
api
/
valuations
List valuations with filters
curl --request GET \
  --url https://api.example.com/api/valuations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "entity_id": 123,
      "value_usd": "<string>",
      "value_eur": "<string>",
      "year": 123,
      "month": 123,
      "is_estimate": true,
      "deleted_at": null
    }
  ],
  "page": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

Auth0 JWT access token

Query Parameters

​
filter
string

Filter expression for valuations.

Examples:

  • Single: year[gte]:2020
  • AND: and(year[gte]:2020,value_usd[gte]:1000000000)

Operators: eq, neq, gt, gte, lt, lte, in_any, nin_any in_all / nin_all are only available on repeated related-record filters. Legacy aliases: in → in_any, nin → nin_any (deprecated, prefer canonical names). Default ref: 'valuation'

Example:

"and(year[gte]:2020,value_usd[gte]:1000000000)"

​
limit
string

Number of results to return (1-2000, default 25)

Example:

"25"

​
offset
string
Example:

"0"

​
sort
string
Pattern: ^-?[\w,]+$
Example:

"-date"

​
include_total
enum<string>
Available options:
true,
false
Example:

"true"

Response

List of valuations

​
data
object[]
required
​
page
object
required