Skip to main content
GET
/
recurrences
Get recurrences
curl --request GET \
  --url https://api.sandbox.monite.com/v1/recurrences \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "automation_level": "draft",
      "current_iteration": 2,
      "day_of_month": "first_day",
      "frequency": "day",
      "interval": 50,
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "iterations": [
        {
          "issue_at": "2023-12-25",
          "status": "pending",
          "issued_invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "iteration": 1
        }
      ],
      "start_date": "2023-12-25",
      "start_month": 6,
      "start_year": 123,
      "status": "active",
      "body_text": "<string>",
      "end_date": "2023-12-25",
      "end_month": 6,
      "end_year": 123,
      "max_occurrences": 500,
      "recipients": {
        "bcc": [
          "jsmith@example.com"
        ],
        "cc": [
          "jsmith@example.com"
        ],
        "to": [
          "jsmith@example.com"
        ]
      },
      "subject_text": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-monite-version
string<date>
required
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Response

Successful Response

data
object[]
required