Custom Attribute Groups

List Custom Attribute Groups

Retrieve all Custom Attribute Groups for a specific entity.

GET

https://api.piggy.eu/api/v3/oauth/clients/custom-attribute-groups

Headers

Authorization

Accept

Bearer {{ personal_access_token }}

application/json

Input parameters

entity string

required

Entity for which Custom Attribute Groups are to be retrieved

Possible values:

business_profilesFor entity: Business Profile (or Shop)

contactFor entity: Contact

rewardFor entity: Reward

promotionFor entity: Promotion (note: use this one when working with Vouchers)

voucherFor entity: Voucher (note: this is for individual vouchers, you'll likely need Promotion instead

giftcardFor entity: Giftcard

giftcard_transactionFor entity: Giftcard Transaction

prepaidFor entity: Prepaid Transaction

bookingFor entity: Booking

visitFor entity: Visit

shiftFor entity: Shift

Response Example

{
    "data": [
        {
            "entity": "promotion",
            "name": "acme_integration",
            "label": "Acme Integration Attributes",
            "created_at": "2023-11-13T16:04:14+00:00",
        },
        {
            "entity": "promotion",
            "name": "general",
            "label": "General",
            "created_at": "2023-10-12T14:32:15+00:00",
        },
    ],
    "meta": []
}

Create Custom Attribute Group

Custom Attributes can be grouped, which can be helpful to identify those attributes that are associated to your integration.

POST

https://api.piggy.eu/api/v3/oauth/clients/custom-attribute-groups

Headers

Authorization

Accept

Bearer {{ personal_access_token }}

application/json

Input parameters

name string

required

A unique internal identifier for this group

label string

optional

Display value for this group

entity string

required

Entity for which this Custom Attribute Group is to be created

Possible values:

business_profilesFor entity: Business Profile (or Shop)

contactFor entity: Contact

rewardFor entity: Reward

promotionFor entity: Promotion (note: use this one when working with Vouchers)

voucherFor entity: Voucher (note: this is for individual vouchers, you'll likely need Promotion instead

giftcardFor entity: Giftcard

giftcard_transactionFor entity: Giftcard Transaction

prepaidFor entity: Prepaid Transaction

bookingFor entity: Booking

visitFor entity: Visit

shiftFor entity: Shift

Response Example

{
    "data": {
        "entity": "promotion",
        "name": "acme_integration",
        "label": "Acme Integration Attributes",
        "created_at": "2023-11-13T16:04:14+00:00",
    },
    "meta": []
}