# Miav

> Miav CSMS API: manage charging stations, sessions, organizations and OCPP traffic.

## Docs

- [Get session](https://docs.miav.com.br/api-reference/charging-sessions/get-session.md): Returns a single charging session by id.
- [Search sessions](https://docs.miav.com.br/api-reference/charging-sessions/search-sessions.md): Lists the charging sessions of the organization, with filters and pagination.
- [Change availability](https://docs.miav.com.br/api-reference/charging-station-commands/change-availability.md): Sends ChangeAvailability to put the connector into or out of service.
- [Change configuration](https://docs.miav.com.br/api-reference/charging-station-commands/change-configuration.md): Sends ChangeConfiguration to write a configuration key on the station.
- [Clear cache](https://docs.miav.com.br/api-reference/charging-station-commands/clear-cache.md): Sends ClearCache so the station drops its local authorization cache.
- [Read configuration](https://docs.miav.com.br/api-reference/charging-station-commands/read-configuration.md): Sends GetConfiguration and returns the station configuration keys.
- [Reset station](https://docs.miav.com.br/api-reference/charging-station-commands/reset-station.md): Sends Reset, soft or hard, to the station.
- [Send DataTransfer](https://docs.miav.com.br/api-reference/charging-station-commands/send-datatransfer.md): Sends DataTransfer with a vendor-specific payload to the station.
- [Start charging](https://docs.miav.com.br/api-reference/charging-station-commands/start-charging.md): Sends RemoteStartTransaction to the station and returns its response.
- [Stop charging](https://docs.miav.com.br/api-reference/charging-station-commands/stop-charging.md): Sends RemoteStopTransaction so the station ends the given transaction.
- [Trigger message](https://docs.miav.com.br/api-reference/charging-station-commands/trigger-message.md): Sends TriggerMessage asking the station to emit the given OCPP message.
- [Unlock connector](https://docs.miav.com.br/api-reference/charging-station-commands/unlock-connector.md): Sends UnlockConnector to release the given connector.
- [Create group](https://docs.miav.com.br/api-reference/charging-station-groups/create-group.md): Creates a station group inside the organization.
- [Delete group](https://docs.miav.com.br/api-reference/charging-station-groups/delete-group.md): Deletes the group; its stations are left ungrouped rather than deleted.
- [Get group](https://docs.miav.com.br/api-reference/charging-station-groups/get-group.md): Returns a single station group by id.
- [Search groups](https://docs.miav.com.br/api-reference/charging-station-groups/search-groups.md): Lists the station groups of the organization, with filters and pagination.
- [Update group](https://docs.miav.com.br/api-reference/charging-station-groups/update-group.md): Updates the name and description of a station group.
- [Search OCPP logs](https://docs.miav.com.br/api-reference/charging-station-logs/search-ocpp-logs.md): Lists the OCPP events recorded by the stations of the organization, with filters and pagination.
- [Create station](https://docs.miav.com.br/api-reference/charging-stations/create-station.md): Registers a station under the organization; the optional password becomes its OCPP Basic auth secret.
- [Delete station](https://docs.miav.com.br/api-reference/charging-stations/delete-station.md): Deletes the station and everything recorded under it: EVSEs, connectors, sessions and logs.
- [Get station](https://docs.miav.com.br/api-reference/charging-stations/get-station.md): Returns a single station by id, with its EVSEs and connectors.
- [Search stations](https://docs.miav.com.br/api-reference/charging-stations/search-stations.md): Lists the stations of the organization, with filters, pagination and the live connection state of each one.
- [Update station](https://docs.miav.com.br/api-reference/charging-stations/update-station.md): Updates the registration data of a station.
- [Dashboard summary](https://docs.miav.com.br/api-reference/dashboard/dashboard-summary.md): Aggregates stations, connectors, sessions and energy over a period, as a time series and optionally broken down per station.
- [Healthcheck](https://docs.miav.com.br/api-reference/healthcheck.md): Responds {"ok":true} while the API is up; it is the target of the deploy smoke check.
- [Add member](https://docs.miav.com.br/api-reference/organization-memberships/add-member.md): Links an existing user to the organization with the given role.
- [Remove member](https://docs.miav.com.br/api-reference/organization-memberships/remove-member.md): Removes a user membership from the organization.
- [Search members](https://docs.miav.com.br/api-reference/organization-memberships/search-members.md): Lists the user memberships of the organization, with filters and pagination.
- [Create organization](https://docs.miav.com.br/api-reference/organizations/create-organization.md): Creates the organization for the authenticated user; each user owns at most one.
- [Get my organization](https://docs.miav.com.br/api-reference/organizations/get-my-organization.md): Returns the organization owned by the authenticated user.
- [Update organization](https://docs.miav.com.br/api-reference/organizations/update-organization.md): Updates the registration data of the user organization.
- [API conventions](https://docs.miav.com.br/conventions.md): Authentication, roles, errors, pagination and filtering, explained once
- [Introduction](https://docs.miav.com.br/index.md): The Miav CSMS API: manage a charging network, its stations and its sessions
- [Quickstart](https://docs.miav.com.br/quickstart.md): From an empty account to a station taking remote commands

## OpenAPI Specs

- [openapi](https://docs.miav.com.br/openapi.json)