Workspace Admin API endpoint requests and responses

This is the request/response reference for every /v2/admin endpoint. Authentication, idempotency, rate limits, token creation, and scope semantics are documented in Workspace Admin API. Reusable field-level types and examples are in Schemas and examples. Read every endpoint row together with Response and error contract, which lists all possible shared and endpoint-specific non-success response bodies.

Common contract

Every path begins with the deployed app-api origin. The workspace is derived exclusively from the authenticated token; clients must not send cpoId. All documented :...Id resource path values are positive decimal integers. Every request requires exactly one:

Authorization: Bearer <workspace-access-token>

Requests shown with a JSON body require Content-Type: application/json. All mutations require Idempotency-Key (POST, PUT, PATCH, and DELETE), including POST /v2/admin/reports/send; unless a row says otherwise, the success content type is application/json, JSON dates are RFC 3339 strings, and numbers are JSON numbers.

Every request may include X-Request-Id and X-Error-Format: envelope; see Response and error contract. These headers do not change success schemas.

Notation used below:

• none means no request body. A DELETE that documents a JSON body still requires that body.
• ? marks an optional property or query parameter.
• T | null means the property is present and nullable.
• 204 empty means no response body.
• CursorPage<T> means { items: T[], nextCursor: number|string|null }, except where the row names a page or pagination object explicitly.
• All nested resource misses, including cross-workspace IDs, use 404 { "error": "Workspace resource not found", "code": "RESOURCE_NOT_FOUND" } unless a feature documents a more specific conflict.

Shared request schemas

Workspace and site inputs

WorkspacePatch = {
  name?: string(1..100), email?: email|null, website?: string|null,
  addressLine1?: string|null, addressLine2?: string|null,
  postalCode?: string|null, city?: string|null, state?: string|null,
  countryId?: positive integer
} // at least one property

SiteInput = {
  name: string(1..255), description?: string|null = null,
  addressLine1?: string|null = null, addressLine2?: string|null = null,
  postalCode?: string|null = null, city?: string|null = null, state?: string|null = null,
  countryId: positive integer, timezoneId: positive integer,
  latitude?: number[-90,90]|null = null, longitude?: number[-180,180]|null = null
}

Power-management input

PowerConfigurationInput = { pools: PowerPoolInput[0..200] }
PowerPoolInput = {
  id?: positive integer|null, name?: string(0..255),
  limit: integer[0,100000000], meterSources?: ExternalMeterInput[0..16],
  children?: (PowerPoolInput | ChargerPoolChild)[0..1000]
}
ChargerPoolChild = { chargepointId: positive integer, priority?: integer[-1000000,1000000] }
ExternalMeterInput = {
  id?: positive integer|null, sourceId?: positive integer|null,
  provider?: "perific", name?: string(0..255), externalId: string(1..80),
  measurementMode?: "available_headroom"|"external_non_ev_load_only"|"total_site_load_including_ev",
  valueMode?: "perific_relative"|"perific_direct"|"perific_meter",
  reserveA?: integer[0,100000], offlineSafeA?: integer[0,100000],
  ttlSeconds?: integer[30,86400], enabled?: boolean
}

Charger inputs

ChargerCreate = { name: string(1..40), identifier: string(1..40), password?: string(0..40) = "", siteId: positive integer }
ChargerPatch = {
  name?: string(1..40), siteId?: positive integer, invertedRfid?: boolean,
  smartMode?: integer[0,3], automationDisabled?: boolean
} // at least one
ConnectorPatch = {
  connectorFormatId: positive integer, connectorTypeId: positive integer,
  powerTypeId: positive integer, maxVoltage: integer[1,10000],
  maxAmperage: integer[1,10000], maxElectricPower: integer[1,100000000]
}

Report inputs

ReportFilters = {
  from?: RFC3339, to?: RFC3339, siteId?: positive integer,
  chargerId?: positive integer, userId?: positive integer,
  anonymous?: true|false|1|0, active?: true|false|1|0
}
ReportScheduleInput = {
  enabled: boolean, recipientEmail: email(max 255; may be empty only when disabled), format: "csv"|"pdf",
  sendDay: integer[1,28], sendTime: UTC "HH:mm"
}

Report ranges must satisfy from < to and may not exceed 90 days. When omitted, the latest 90-day window is used. userId and anonymous=true are mutually exclusive. Scheduled exports catch up after a missed UTC minute and use bounded retries (5/10-minute backoff, 30-minute stale-claim lease, three attempts).

Tariff inputs

TariffInput = {
  name: string(1..64),
  exactly one of currencyId: positive integer, currencyCode: 3 letters, currency: 3 letters,
  biddingZoneId?: positive integer|null, tax?: finite number
}
TariffComponentInput = {
  typeId: positive integer, seasonId: positive integer, priority?: finite number,
  price: finite number, validFromMonth?: finite number, validToMonth?: finite number,
  validFromWeekDay?: finite number, validToWeekDay?: finite number,
  validFromHour?: finite number, validToHour?: finite number
}
TariffAssignmentCreateInput = { tariffId: positive integer, connectorId?: nonnegative integer }
TariffAssignmentUpdateInput = { tariffId: positive integer, connectorId: positive integer }

Charging-profile inputs

ChargingProfileInput = {
  label: string(1..40), locationId: positive integer, stackLevel: nonnegative number,
  purposeId: positive integer, kindId: positive integer,
  recurrencyKindId?: positive integer|null, validFrom?: RFC3339|null,
  validTo?: RFC3339|null, startSchedule?: RFC3339|null,
  rateUnitId: positive integer, minChargingRate?: nonnegative number|null
}
ChargingProfileCreate = ChargingProfileInput & { schedule?: SchedulePeriod[0..256] }
SchedulePeriod = { startPeriod: nonnegative number, limit: nonnegative number, numberOfPhases?: positive integer|null }
ChargingScheduleInput = { rateUnitId: positive integer, periods: SchedulePeriod[1..256] }
ProfileAssignmentInput = { profileId: positive integer, connectorId?: nonnegative integer }

User inputs

UserCreate = { email: email(max 255), name: string(1..255) }
InvitationInput = {
  email: email, name?: string|null, rfid?: string|null,
  allChargers?: boolean, chargerIds?: unique positive integer[0..500]
} // chargerIds must be non-empty unless allChargers=true
AccessInput = { allChargers?: boolean, chargerIds?: unique positive integer[0..500] }
LimitCreate = { limitTypeId: positive integer, energyValue?: nonnegative integer = 0, timeValue?: nonnegative integer = 0 }
LimitPatch = { limitTypeId?: positive integer, energyValue?: nonnegative integer, timeValue?: nonnegative integer }

At least one of energyValue or timeValue must be greater than zero when creating a limit. Emails are trimmed and lowercased. RFID UIDs are accepted only on writes and are masked in read responses.

Response DTO summary

The endpoint tables show every top-level response envelope. These are the principal reusable DTOs inside those envelopes:

Lookup objects are returned by list/detail routes so callers can discover valid IDs. Treat unknown added fields as forward-compatible and branch only on documented stable fields and error codes.

Workspace endpoints

Site and power-management endpoints

Charger endpoints

Report endpoints

Tariff endpoints

TariffAssignment contains id, chargerId, connectorId, a safe tariff/currency summary, createdAt, and updatedAt.

Charging-profile endpoints

ProfileAssignment contains its assignment ID, charger/connector IDs, and safe profile summary. OCPP result objects expose stable request/status information and never credentials.

User, RFID, access, limit, and local-user endpoints

The Tagless system user is protected from these operations. Invitation email failures return safe delivery state without leaking SMTP details; callers can retry when emailRetryReady is true.

Binary responses

Two endpoint families do not return JSON on success:

Errors from binary endpoints are still JSON.