Get All Plans
Changed onQuery all data plans
Request
- Base URLhttps://api.mparticle.com/platform/v2/workspaces/0/plans
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Whether to include each version's version_document. When true, at most 50 versions are returned per plan, and currentPage and pageSize apply to each plan separately. If any plan has more than 50 versions and neither currentPage nor pageSize is passed, the request returns 400 naming those plans.
Page of plan versions to return, starting at 1. Only applies when includeDocument=true. Versions are returned newest first: page 1 holds the highest version numbers, and each page lists them in descending version order. Defaults to 1 when only pageSize is passed. A page past the last version returns an empty data_plan_versions list.
Number of plan versions per page, from 1 to 50. Only applies when includeDocument=true. Defaults to 50 when only currentPage is passed. If neither currentPage nor pageSize is passed and the plan has more than 50 versions, the request returns 400.
Response
Data plan list
Changes
- info
added the new optional
queryrequest parametercurrentPage - info
added the new optional
queryrequest parameterincludeDocument - info
added the new optional
queryrequest parameterpageSize - info
added the media type
application/jsonfor the response with the status
- info