{ "opencollection": "1.0.0", "info": { "name": "m3ter Account PlanGroup API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "PlanGroup", "type": "folder" }, "items": [ { "info": { "name": "List PlanGroups", "type": "http" }, "http": { "method": "GET", "url": "https://api.m3ter.com/organizations/:orgId/plangroups", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service." }, { "name": "pageSize", "value": "", "type": "query", "description": "Specifies the maximum number of PlanGroups to retrieve per page." }, { "name": "nextToken", "value": "", "type": "query", "description": "The `nextToken` for multi-page retrievals. It is used to fetch the next page of PlanGroups in a paginated list." }, { "name": "accountId", "value": "", "type": "query", "description": "Optional filter. The list of Account IDs to which the PlanGroups belong." }, { "name": "ids", "value": "", "type": "query", "description": "Optional filter. The list of PlanGroup IDs to retrieve." } ] }, "docs": "Retrieve a list of PlanGroups.\n\nRetrieves 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." }, { "info": { "name": "Create PlanGroup", "type": "http" }, "http": { "method": "POST", "url": "https://api.m3ter.com/organizations/:orgId/plangroups", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new PlanGroup.\nThis endpoint creates a new PlanGroup within the specified organization." }, { "info": { "name": "Retrieve PlanGroup", "type": "http" }, "http": { "method": "GET", "url": "https://api.m3ter.com/organizations/:orgId/plangroups/:id", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service." }, { "name": "id", "value": "", "type": "path", "description": "The unique identifier (UUID) of the PlanGroup to retrieve." } ] }, "docs": "Retrieve a specific PlanGroup with the given UUID.\n\nThis endpoint retrieves detailed information about a specific PlanGroup identified by the given UUID within a specific organization." }, { "info": { "name": "Update PlanGroup", "type": "http" }, "http": { "method": "PUT", "url": "https://api.m3ter.com/organizations/:orgId/plangroups/:id", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service." }, { "name": "id", "value": "", "type": "path", "description": "The unique identifier (UUID) of the PlanGroup to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the PlanGroup with the given UUID.\n\nThis endpoint updates the details of a specific PlanGroup identified by the given UUID within a specific organization. This allows modifications to existing PlanGroup attributes.\n\n**Note:** If you have created Custom Fields for a PlanGroup, when you use this endpoint to update the PlanGroup use the `customFields` parameter to preserve those Custom Fields. If you omit them from the update request, they will be lost." }, { "info": { "name": "Delete PlanGroup", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.m3ter.com/organizations/:orgId/plangroups/:id", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service." }, { "name": "id", "value": "", "type": "path", "description": "The unique identifier (UUID) of the PlanGroup to delete." } ] }, "docs": "Delete a PlanGroup with the given UUID.\n\nThis endpoint deletes the PlanGroup identified by the given UUID within a specific organization. This operation is irreversible and removes the PlanGroup along with any associated settings." } ] } ], "bundled": true }