Tier Structures

List tier structures

<Info>

<Badge color="gray">Documentation in progress</Badge>

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

</Info>

Returns a cursor-paginated list of tier structures. The same field cannot be requested in both ascending and descending order at once. Default order is -created_at.

get/v2/loyalties/tier-structures

Query parameters

limitinteger

Maximum number of items returned per page. An integer between 1 and 100. Defaults to 10.

'-created_at' | 'created_at' | 'name' | '-name' | 'type' | '-type' | 'status' | '-status'
OR
string[]

Sort order. A single field name or an array of field names; prefix a field with - for descending order. Default is -created_at. The same field must not be requested in both ascending and descending direction at once.

cursorstring

Pagination cursor returned in the cursor.next field of a previous response. Must match the tier structures cursor id format.

junction'AND' | 'OR' nullable

Logical junction combining the field filters. Defaults to AND semantics.

Field-specific filter conditions, passed as a deep object (e.g. filters[status][conditions][$is]=ACTIVE).

Response

Paginated list of tier structures.

object'list' required

Object type discriminator. Always list.

Changes

Changed in 3 of the 62 revisions of this API.143538

  • v2703a0a42ea4311See the full diff
    • added the new NO_RETENTION enum value to the /// response property for the response status

      response-property-enum-value-added

    • removed the NO_EXPIRATION enum value from the /// response property for the response status

      response-property-enum-value-removed

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

  • v2341403eb19e5143429See the full diff
    • added the pattern ^lcrsts_[a-f0-9]+$ to the query request parameter cursor

      request-parameter-pattern-added

    • the response property // became nullable for the status

      response-property-became-nullable

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the response property became optional for the status

      response-property-became-optional

    • the // response property's maxLength was unset from 200 for the response status

      response-property-max-length-unset

    • added subschema #1 to the response property oneOf list for the response status

      response-property-one-of-added

    • the // response's property type changed from no type to object for status

      response-property-type-changed

    • the // response's property type changed from no type to object for status

      response-property-type-changed

    • the // response's property type changed from no type to object for status

      response-property-type-changed

    • removed the required property // from the response with the status

      response-required-property-removed

    • deleted the query request parameter filters[created_at][conditions][$after]

      request-parameter-removed

    • deleted the query request parameter filters[created_at][conditions][$before]

      request-parameter-removed

    • deleted the query request parameter filters[created_at][conditions][$has_value]

      request-parameter-removed

    • deleted the query request parameter filters[created_at][conditions][$is]

      request-parameter-removed

    • deleted the query request parameter filters[created_at][conditions][$is_unknown]

      request-parameter-removed

    • deleted the query request parameter filters[created_at][conditions][$less_than]

      request-parameter-removed

    • deleted the query request parameter filters[created_at][conditions][$more_than]

      request-parameter-removed

    • deleted the query request parameter filters[id][conditions][$in]

      request-parameter-removed

    • deleted the query request parameter filters[id][conditions][$is]

      request-parameter-removed

    • deleted the query request parameter filters[id][conditions][$is_not]

      request-parameter-removed

    • deleted the query request parameter filters[id][conditions][$not_in]

      request-parameter-removed

    • deleted the query request parameter filters[junction]

      request-parameter-removed

    • deleted the query request parameter filters[name][conditions][$contains]

      request-parameter-removed

    • deleted the query request parameter filters[name][conditions][$ends_with]

      request-parameter-removed

    • deleted the query request parameter filters[name][conditions][$has_value]

      request-parameter-removed

    • deleted the query request parameter filters[name][conditions][$in]

      request-parameter-removed

    • deleted the query request parameter filters[name][conditions][$is]

      request-parameter-removed

    • deleted the query request parameter filters[name][conditions][$is_not]

      request-parameter-removed

    • deleted the query request parameter filters[name][conditions][$is_unknown]

      request-parameter-removed

    • deleted the query request parameter filters[name][conditions][$not_contain]

      request-parameter-removed

    • deleted the query request parameter filters[name][conditions][$not_in]

      request-parameter-removed

    • deleted the query request parameter filters[name][conditions][$starts_with]

      request-parameter-removed

    • deleted the query request parameter filters[status][conditions][$in]

      request-parameter-removed

    • deleted the query request parameter filters[status][conditions][$is]

      request-parameter-removed

    • deleted the query request parameter filters[status][conditions][$is_not]

      request-parameter-removed

    • deleted the query request parameter filters[status][conditions][$not_in]

      request-parameter-removed

    • deleted the query request parameter filters[type][conditions][$in]

      request-parameter-removed

    • deleted the query request parameter filters[type][conditions][$is]

      request-parameter-removed

    • deleted the query request parameter filters[type][conditions][$is_not]

      request-parameter-removed

    • deleted the query request parameter filters[type][conditions][$not_in]

      request-parameter-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • added the new optional query request parameter filters

      new-optional-request-parameter

    • query request parameter order list-of-types was widened by adding types string

      request-parameter-list-of-types-widened

    • for the query request parameter order, the type was generalized from array to no type

      request-parameter-type-generalized

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • the response property became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property const value list was added for the status

      response-property-const-added

    • the response property const value tier_structure was added for the status

      response-property-const-added

    • removed the list enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the tier_structure enum value from the // response property for the response status

      response-property-enum-value-removed

    • response property data/items/updated_at list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • removed from the response property oneOf list for the response status

      response-property-one-of-removed

    • removed subschema #2 from the // response property oneOf list for the response status

      response-property-one-of-removed

    • removed subschema #2 from the // response property oneOf list for the response status

      response-property-one-of-removed

    • removed subschema #2 from the // response property oneOf list for the response status

      response-property-one-of-removed

    • the // response's property pattern ^lts_[a-f0-9]+$ was added for the status

      response-property-pattern-added

    This revision also has 292 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog