API ReferenceCustomer APICustomizations

List customization profiles (discovery)

Read-only discovery endpoint for the account's customization profiles. Use it to look up the exact `minstay_profile_id` / `pricing_profile_id` / `checkincheckout_profile_id` values that `custom_seasonal_profile` season writes accept — the ids returned here are exactly the set a write will validate against (same account-ownership rule). Returns all three profile types grouped by type; filter with `profile_type`, `archived`, or look up a single profile by exact `name` (requires `profile_type`; at most one match — profile names are unique per account and type). A name with no match returns `404 ERR-PROFILE-NOT-FOUND`; the response is identical for nonexistent and not-owned names. Entries expose only `id`, `name` and `archived` — not the profile's contents.

Headers

X-API-KeystringRequired

Query parameters

profile_typeenumOptional

Return only this profile type; omit for all three.

Allowed values:
archivedbooleanOptional

Filter by archived state. false also includes legacy profiles that never set the flag. Omit to return both archived and unarchived profiles.

namestringOptional

Exact-match name lookup. Requires profile_type. Returns at most one profile; no match returns 404 ERR-PROFILE-NOT-FOUND.

Response

Profiles retrieved
profilesobjectOptional

Profiles grouped by type. Types filtered out by profile_type are omitted; a type with no profiles is an empty array.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error