PlanGroup

Retrieve a list of PlanGroups.

Retrieves a list of PlanGroups within the specified organization. You can optionally filter by Account IDs or PlanGroup IDs, and also paginate the results for easier management.

get/organizations/{orgId}/plangroups

Request

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

Query parameters

pageSizeinteger

Specifies the maximum number of PlanGroups to retrieve per page.

nextTokenstring

The nextToken for multi-page retrievals. It is used to fetch the next page of PlanGroups in a paginated list.

accountIdstring[]

Optional filter. The list of Account IDs to which the PlanGroups belong.

idsstring[]

Optional filter. The list of PlanGroup IDs to retrieve.

Response

Returns the list of PlanGroups

nextTokenstring

Changes

    • breaking

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

    • breaking

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

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status