API reference/Goals

List revenue goals

Try it

Page through this workspace's persisted monthly goals.

GET/api/v1/goals

Authentication

Send your workspace key as xi-api-key or Authorization: Bearer.

goals:readread

Parameters

Named placeholders belong in the path. Other arguments use query parameters.

limitOptional: integerRange: 1 to 100
offsetOptional: integerRange: 0 to 100000

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "limit": 50,
  "offset": 0
}

Input schema

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    }
  },
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "period": {
            "type": "string"
          },
          "amount": {
            "type": "number"
          }
        },
        "required": [
          "period",
          "amount"
        ],
        "additionalProperties": false
      }
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "limit",
    "offset",
    "hasMore"
  ],
  "additionalProperties": false
}