List fields

GET

/v1/fields

curl "https://api.summerbase.com/v1/fields" \
  -H "Authorization: Bearer sb_..."

Every key a filter’s comparison or a breakdown’s dimension may name in the project you are working in: the fields a customer, a subscription and a subscription item carry, the properties each source has written about them, and the run rate movements’ own dimensions. Each says what it holds and where it may be used.

Parameters

Query Parameters

limit

integer

default: 20 >= 1 <= 100

How many records to return, 1 to 100. Defaults to 20.

cursor

string

The next_cursor of the previous page, to read the page after it.

include_total_count

boolean

Whether to add total_count, how many records match altogether. On the first page only: it is the same number on every page of one list, so keep the first page’s, and it is refused beside a cursor.

Response

Returns a list of field objects, a page at a time. See Pagination.

Media typeapplication/json

Example

{
  "data": [
    {
      "at_supported": true,
      "breakdown_supported": true,
      "filter_supported": true,
      "id": "customer.first_paying_at",
      "label": "First Paying At",
      "object": "field",
      "origin": "derived",
      "promoted": false,
      "references": null,
      "source_slug": null,
      "subject_type": "customer",
      "value_type": "datetime"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "object": "list",
  "total_count": 1
}