List

API Reference

V1

Plans

List plans

get/v1/plans

List all available plans.

Query Parameters

limitnumber

optional

Max number of results that should be returned

minimum1

maximum100

next_pagestring

optional

Cursor that indicates where the next page of results should start.

Returns

dataarray of object

next_pagestring

HTTPTypeScriptPythonGoRubyTerraform

curl https://api.metronome.com/v1/plans \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN"

200 Example

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "description": "description",
      "name": "name",
      "custom_fields": {
        "foo": "string"
      }
    }
  ],
  "next_page": "next_page"
}