Groups

Query groups

Changed on

Use when listing or searching groups (e.g. admin catalog). Returns a paginated list; supports filtering and sorting.

post/groups/search

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/groups/search
  • Auth
    API key in header x-api-key

Request body

end_timestring date-time
entity_typestring
expandstring
group_idsstring[]

Group specific filters

limitinteger
lookup_keystring
namestring
offsetinteger
order'asc' | 'desc'
start_timestring date-time
status'published' | 'deleted' | 'archived'

Response

OK

Changes

  • f8ecf435d25dRevision changes
    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

    • info

      added the new gte enum value to the request property //

  • 646d6658479bRevision changes
    • breaking

      the request property format changed from no format to date-time

    • breaking

      the request property format changed from no format to date-time