Get Product Family

GET

/api/:account_id/product-families/:family_id

Get a product family by ID.

AuthorizationBearer

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

family_idstringRequired

account_idstringRequired

include_deletedbooleanOptionalDefaults to false

Include soft-deleted families

Successful Response

idstring

account_idstring

namestring

created_atdatetime

updated_atdatetime

descriptionstring or nullOptional

hierarchymap from strings to integersOptional

deleted_atdatetime or nullOptional

422

Unprocessable Entity Error

$	curl -G https://app.paymentkit.com/api/account_id/product-families/family_id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d include_deleted=false

1	{
2	"id": "fam_123456789",
3	"account_id": "acc_987654321",
4	"name": "Electronics Accessories",
5	"created_at": "2024-01-15T09:30:00Z",
6	"updated_at": "2024-04-10T14:45:00Z",
7	"description": "A product family including chargers, cables, and adapters.",
8	"hierarchy": {
9	"chargers": 1,
10	"cables": 2,
11	"adapters": 3
12	},
13	"deleted_at": null
14	}