Schedules

Retrieve a list of schedules.

GET

https://partner-api.monta.com

/api/v1/schedules

Required scope: schedules:read
Organization authorization: supported

Retrieve a list of schedules. › query Parameters

teamId

integer · int64

Filter by team id. When omitted, returns all schedules owned by the consumer's operator.

search

string · maxLength: 200

Free-text search filter by schedule name. Max 200 characters.

page

integer · int32

Page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

Number of items per page (between 1 and 100, default 10)

Default: 10

Retrieve a list of schedules. › Responses

List of schedules that match the criteria

OffsetBasedResponse_52

Schedule[] · required

MontaPage.Meta · required

GET/api/v1/schedules

curl https://partner-api.monta.com/api/v1/schedules \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 42,
      "teamId": 12,
      "name": "Weekday Hours",
      "visibility": "public",
      "timezone": "Europe/Copenhagen",
      "priceGroupId": 99,
      "entryCount": 5,
      "entries": [
        {
          "id": 12,
          "dayOfWeek": "mon",
          "from": "08:00:00",
          "to": "18:00:00",
          "visibility": "public",
          "priceGroupId": 42
        }
      ],
      "selectedChargePointIds": [
        0
      ],
      "selectedSiteIds": [
        0
      ],
      "createdAt": "2023-03-16T15:37:23Z",
      "updatedAt": "2023-03-16T15:37:23Z"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Create a schedule.

POST

https://partner-api.monta.com

/api/v1/schedules

Required scope: schedules:write
Organization authorization: supported

Create a schedule. › Request Body

CreateScheduleDto

teamId

integer · int64 · required

Id of the team that should own this schedule

Example: 12

name

string · minLength: 1 · maxLength: 255 · required

Name of the schedule

Example: Weekday Hours

timezone

string · minLength: 1 · required

Timezone for interpreting the schedule entry times

Example: Europe/Copenhagen

visibility

string · enum

Default visibility for charge points in this schedule. Defaults to public when omitted.

Enum values:

private

public

Example: public

priceGroupId

integer | null · int64

Id of the default price group applied during scheduled windows. Defaults to the team's default price group when omitted.

Example: 99

selectedChargePointIds

array | null · maxItems: 1000

Ids of charge points to assign to this schedule

Example: [1,2]

selectedSiteIds

array | null · maxItems: 1000

Ids of sites to assign to this schedule

Example: [10]

array | null · maxItems: 100

Time windows that make up this schedule

Create a schedule. › Responses

Schedule created

Schedule

id

integer · int64 · required

Id of the schedule

Example: 42

teamId

integer · int64 · required

Id of the team that owns this schedule

Example: 12

name

string · required

Name of the schedule

Example: Weekday Hours

visibility

string · enum · required

Default visibility for charge points in this schedule

Enum values:

private

public

Example: public

timezone

string · required

Timezone for interpreting the schedule entry times

Example: Europe/Copenhagen

entryCount

integer · int32 · required

Number of entries in this schedule

Example: 5

createdAt

string · date-time · required

When the schedule was created

Example: 2023-03-16T15:37:23Z

priceGroupId

integer | null · int64

Id of the default price group applied during scheduled windows

Example: 99

array | null

List of schedule entries defining time windows and their overrides

selectedChargePointIds

array | null

Ids of charge points directly assigned to this schedule

selectedSiteIds

array | null

Ids of sites assigned to this schedule

updatedAt

string | null · date-time

When the schedule was last updated

Example: 2023-03-16T15:37:23Z

POST/api/v1/schedules

curl https://partner-api.monta.com/api/v1/schedules \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "teamId": 12,
  "name": "Weekday Hours",
  "visibility": "public",
  "timezone": "Europe/Copenhagen",
  "priceGroupId": 99,
  "selectedChargePointIds": [
    1,
    2
  ],
  "selectedSiteIds": [
    10
  ],
  "entries": [
    {
      "dayOfWeek": "mon",
      "from": "08:00",
      "to": "18:00",
      "visibility": "public",
      "priceGroupId": 42
    }
  ]
}'

Example Request Body

{
  "teamId": 12,
  "name": "Weekday Hours",
  "visibility": "public",
  "timezone": "Europe/Copenhagen",
  "priceGroupId": 99,
  "selectedChargePointIds": [
    1,
    2
  ],
  "selectedSiteIds": [
    10
  ],
  "entries": [
    {
      "dayOfWeek": "mon",
      "from": "08:00",
      "to": "18:00",
      "visibility": "public",
      "priceGroupId": 42
    }
  ]
}

json

Example Responses

{
  "id": 42,
  "teamId": 12,
  "name": "Weekday Hours",
  "visibility": "public",
  "timezone": "Europe/Copenhagen",
  "priceGroupId": 99,
  "entryCount": 5,
  "entries": [
    {
      "id": 12,
      "dayOfWeek": "mon",
      "from": "08:00:00",
      "to": "18:00:00",
      "visibility": "public",
      "priceGroupId": 42
    }
  ],
  "selectedChargePointIds": [
    0
  ],
  "selectedSiteIds": [
    0
  ],
  "createdAt": "2023-03-16T15:37:23Z",
  "updatedAt": "2023-03-16T15:37:23Z"
}

json

application/json

Retrieve a schedule.

GET

https://partner-api.monta.com

/api/v1/schedules/{id}

Required scope: schedules:read
Organization authorization: supported

Retrieve a schedule. › path Parameters

id

integer · int64 · required

Retrieve a schedule. › Responses

Schedule with provided id

Schedule

id

integer · int64 · required

Id of the schedule

Example: 42

teamId

integer · int64 · required

Id of the team that owns this schedule

Example: 12

name

string · required

Name of the schedule

Example: Weekday Hours

visibility

string · enum · required

Default visibility for charge points in this schedule

Enum values:

private

public

Example: public

timezone

string · required

Timezone for interpreting the schedule entry times

Example: Europe/Copenhagen

entryCount

integer · int32 · required

Number of entries in this schedule

Example: 5

createdAt

string · date-time · required

When the schedule was created

Example: 2023-03-16T15:37:23Z

priceGroupId

integer | null · int64

Id of the default price group applied during scheduled windows

Example: 99

array | null

List of schedule entries defining time windows and their overrides

selectedChargePointIds

array | null

Ids of charge points directly assigned to this schedule

selectedSiteIds

array | null

Ids of sites assigned to this schedule

updatedAt

string | null · date-time

When the schedule was last updated

Example: 2023-03-16T15:37:23Z

Update a schedule.

PUT

https://partner-api.monta.com

/api/v1/schedules/{id}

Required scope: schedules:write
Organization authorization: supported

Update a schedule. › path Parameters

id

integer · int64 · required

Update a schedule. › Request Body

UpdateSchedule

name

string | null · minLength: 1 · maxLength: 255

Name of the schedule.

Example: Weekday Hours

price_group_id

integer | null · int64

Id of the default price group applied during scheduled windows.

Example: 99

visibility

string · enum

Default visibility for charge points in this schedule.

Enum values:

private

public

Example: public

timezone

string | null · minLength: 1 · maxLength: 255

Timezone for interpreting the schedule entry times.

Example: Europe/Copenhagen

selected_charge_point_ids

array | null

Replaces the set of charge points assigned to this schedule. Omit to leave unchanged.

selected_site_ids

array | null

Replaces the set of sites assigned to this schedule. Omit to leave unchanged.

array | null

Replaces the schedule entries. Omit to leave unchanged.

Update a schedule. › Responses

The updated schedule

Schedule

id

integer · int64 · required

Id of the schedule

Example: 42

teamId

integer · int64 · required

Id of the team that owns this schedule

Example: 12

name

string · required

Name of the schedule

Example: Weekday Hours

visibility

string · enum · required

Default visibility for charge points in this schedule

Enum values:

private

public

Example: public

timezone

string · required

Timezone for interpreting the schedule entry times

Example: Europe/Copenhagen

entryCount

integer · int32 · required

Number of entries in this schedule

Example: 5

createdAt

string · date-time · required

When the schedule was created

Example: 2023-03-16T15:37:23Z

priceGroupId

integer | null · int64

Id of the default price group applied during scheduled windows

Example: 99

array | null

List of schedule entries defining time windows and their overrides

selectedChargePointIds

array | null

Ids of charge points directly assigned to this schedule

selectedSiteIds

array | null

Ids of sites assigned to this schedule

updatedAt

string | null · date-time

When the schedule was last updated

Example: 2023-03-16T15:37:23Z

PUT/api/v1/schedules/{id}

curl https://partner-api.monta.com/api/v1/schedules/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Weekday Hours",
  "price_group_id": 99,
  "visibility": "public",
  "timezone": "Europe/Copenhagen",
  "selected_charge_point_ids": [
    0
  ],
  "selected_site_ids": [
    0
  ],
  "entries": [
    {
      "id": 12,
      "day_of_week": "mon",
      "from": "08:00:00",
      "to": "18:00:00",
      "visibility": "public",
      "price_group_id": 42
    }
  ]
}'

Example Request Body

{
  "name": "Weekday Hours",
  "price_group_id": 99,
  "visibility": "public",
  "timezone": "Europe/Copenhagen",
  "selected_charge_point_ids": [
    0
  ],
  "selected_site_ids": [
    0
  ],
  "entries": [
    {
      "id": 12,
      "day_of_week": "mon",
      "from": "08:00:00",
      "to": "18:00:00",
      "visibility": "public",
      "price_group_id": 42
    }
  ]
}

json

Example Responses

{
  "id": 42,
  "teamId": 12,
  "name": "Weekday Hours",
  "visibility": "public",
  "timezone": "Europe/Copenhagen",
  "priceGroupId": 99,
  "entryCount": 5,
  "entries": [
    {
      "id": 12,
      "dayOfWeek": "mon",
      "from": "08:00:00",
      "to": "18:00:00",
      "visibility": "public",
      "priceGroupId": 42
    }
  ],
  "selectedChargePointIds": [
    0
  ],
  "selectedSiteIds": [
    0
  ],
  "createdAt": "2023-03-16T15:37:23Z",
  "updatedAt": "2023-03-16T15:37:23Z"
}

json

application/json

Delete a schedule.

DELETE

https://partner-api.monta.com

/api/v1/schedules/{id}

Required scope: schedules:delete
Organization authorization: supported

Delete a schedule. › path Parameters

id

integer · int64 · required

Delete a schedule. › Responses

Schedule successfully deleted

No data returned

Revenue Share Sites