List property definitions

GET

/v1/property_definitions

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

The property keys seen in the project you are working in, what each one holds, and which source they came from.

Parameters

Query Parameters

subject_type

string

Allowed values: customer subscription subscription_item plan price

Only the keys describing this kind of record.

archived

boolean

Only archived keys, or only current ones. Both, by default.

sort

The order: a key, - before it for descending, commas between up to 3 keys — -created_at, name, -mrr,name. The keys are created_at, key, label. Text sorts ignoring case; a record with no value for the key comes last, whichever way the list runs.

string

The order.

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.

expand[]

Array<string>

<= 10 items

Allowed values: source

Relationships to include in the response instead of fetching separately. A dotted path expands what an expanded record can expand in turn — at most 4 deep, 10 paths a request, and never back to a record already on the path.

Response

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

Media typeapplication/json

Example

{
  "data": [
    {
      "archived": false,
      "created_at": "2026-02-11T09:20:13Z",
      "id": "0198f1a5-7a8b-7c9d-8e0f-1a2b3c4d5e6f",
      "key": "seats",
      "label": "Seats",
      "object": "property_definition",
      "source_id": "0198f1a3-0c18-7d93-a6e2-1b4f9d7c3a58",
      "subject_type": "customer",
      "value_type": "number"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "object": "list",
  "total_count": 1
}