List Product Families | PaymentKit

List all product families for the account.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

account_idstringRequired

include_deletedbooleanOptionalDefaults to false

Include soft-deleted families

limitintegerOptional1-100Defaults to 50

Number of items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

filterstringOptionalDefaults to {}

Filter conditions as key-value pairs or advanced filter objects (JSON string)

sortBystring or nullOptional

Field to sort by

sortOrderintegerOptionalDefaults to -1

Sort order: 1 for ascending, -1 for descending

searchstring or nullOptional

Keyword-based search across multiple fields

Successful Response

itemslist of objects

totalinteger

has_moreboolean

1	{
2	"items": [
3	{
4	"id": "pf_8a7b3c2d4e5f6g7h8i9j0k",
5	"account_id": "acct_1234567890abcdef",
6	"name": "Electronics",
7	"created_at": "2023-11-01T12:00:00Z",
8	"updated_at": "2024-01-10T15:45:00Z",
9	"description": "Product family for all electronic devices and accessories",
10	"hierarchy": {
11	"level1": 1,
12	"level2": 3
13	},
14	"deleted_at": "2024-01-15T09:30:00Z"
15	}
16	],
17	"total": 1,
18	"has_more": true
19	}

1	curl https://app.paymentkit.com/api/account_id/product-families/ \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json"