Design KitsVersion: v3New
Get Design Kit
GET/brand-boards/locations/{locationId}/design-kits/{designKitId}
Get a design kit by ID
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
brand-boards/Auth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Example:
v3Path Parameters
locationIdstringrequired
ID of the location that owns the design kit.
Example:
oHJiAh0wDG3BzmzACVD6designKitIdstringrequired
ID of the design kit to retrieve.
Example:
507f1f77bcf86cd799439011Response
Success
idstringrequired
Unique identifier of the design kit.
Example:
507f1f77bcf86cd799439011namestringrequired
Display name of the design kit.
Example:
My Design KitisDefaultbooleanrequired
Whether this is the default design kit for the location.
Example:
falsecreatedAtstringrequired
ISO 8601 timestamp of when the design kit was created.
Example:
2024-01-05T12:00:00.000ZupdatedAtstringrequired
ISO 8601 timestamp of when the design kit was last updated.
Example:
2024-01-05T12:00:00.000ZlocationIdstringrequired
ID of the location that owns the design kit.
Example:
oHJiAh0wDG3BzmzACVD6deletedbooleanrequired
Whether the design kit has been soft-deleted.
Example:
falselogosobject[]
Logos belonging to the design kit.
colorsobject[]
Colors belonging to the design kit.
fontsobject[]
Fonts belonging to the design kit.
traceIdstring
Trace identifier for the request, useful for debugging and support.
Example:
019e4ef5-a65e-4198-8cf9-8e93dca9bda4