List enrollments

https://api.kustom.co/ipp/v1/enrollments

Returns a paginated list of enrollments for the merchant. Soft-deleted (CANCELLED) enrollments are always excluded. Results can be filtered by location, by metadata key-value pairs, and by whether consumed enrollments are included.

Parameters

200

400

401

Example

Parameters5 fields

• location_idstring · uuidoptionalin query

  Filter by location ID.

• metadataarray<string>optionalin query

  Filter by metadata key-value pair. Format: key:value. Repeat the parameter to apply multiple filters — all must match (AND semantics). Maximum 5 entries. Duplicate keys are not allowed.

• include_consumedbooleanoptionalin query

  Whether to include CONSUMED enrollments. Defaults to true.

• page_numberinteger · int32optionalin query

  Zero-based page number. Defaults to 0.

• page_sizeinteger · int32optionalin query

  Page size. Defaults to 20.

200

Response7 fields

Paginated list of enrollments.

• content[]array<any>optional
• total_elementsinteger · int64optional
• total_pagesinteger · int32optional
• page_numberinteger · int32optional
• page_sizeinteger · int32optional
• firstbooleanoptional
• lastbooleanoptional

400

Response0 fields

Invalid request parameters.

No response body — this status returns headers only.

401

Response0 fields

Missing or invalid credentials.

No response body — this status returns headers only.

GET https://api.kustom.co/ipp/v1/enrollments

Response200400401

Response 200· Paginated list of enrollments.

{
  "content": [
    "<string>"
  ],
  "total_elements": 0,
  "total_pages": 0,
  "page_number": 0,
  "page_size": 0,
  "first": false,
  "last": false
}

11 linesCopy

Response 400· Invalid request parameters.

No response body.

This status returns headers only — there is nothing to parse.

—

Response 401· Missing or invalid credentials.

No response body.

This status returns headers only — there is nothing to parse.

—