Sign in
PlanGroup

List PlanGroups

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

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

Changed in 2 of the 10 revisions of this API.232

  • 9f9e5f3dbde712See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the optional property data to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property nextToken to the response with the 200 status

      response-optional-property-added

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

  • 9433593378b513See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ●

      for the query request parameter accountId, the type/format of property items/ was changed from object/ to string/

      request-parameter-property-type-changed

    • ●

      removed the optional property data from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property nextToken from the response with the 200 status

      response-optional-property-removed

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