Skip to main content
GET
/
organizations
/
{orgId}
/
plangrouplinks
List PlanGroupLinks
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/plangrouplinks \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "planGroupId": "<string>",
      "planId": "<string>",
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>"
    }
  ],
  "nextToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

UUID of the organization

Query Parameters

​
pageSize
integer<int32>

Number of PlanGroupLinks to retrieve per page

Required range: 1 <= x <= 100
​
nextToken
string

nextToken for multi page retrievals

​
planGroup
string

UUID of the PlanGroup to retrieve PlanGroupLinks for

​
plan
string

UUID of the Plan to retrieve PlanGroupLinks for

​
ids
string[]

list of IDs to retrieve

Response

ListPlanGroupLinks 200 response

​
data
object[]
​
nextToken
string