Organizations API — Members, Roles, and Settings

Organizations are the top-level tenants in Dynamo CSMS. Every charge point, project, and billing record belongs to an organization. You can invite team members with scoped roles, manage site owner onboarding, and configure organization-wide settings from these endpoints.

Authentication

Authorization: Bearer YOUR_API_KEY
# or
X-API-Key: YOUR_API_KEY

Organizations

Create an organization

POST /api/v1/organizations

name

string

required

Display name for the organization.

country

string

required

ISO 3166-1 alpha-2 country code (e.g., "GB", "DE", "US").

contact_email

string

required

Primary contact email address for the organization.

curl -X POST https://api.dynamo-csms.com/api/v1/organizations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Greenway Charging Ltd",
    "country": "GB",
    "contact_email": "ops@greenway.example.com"
  }'

{
  "id": "org_01HX7A3B2C4D5E6F",
  "name": "Greenway Charging Ltd",
  "country": "GB",
  "contact_email": "ops@greenway.example.com",
  "created_at": "2024-01-20T09:00:00Z"
}

Get an organization

GET /api/v1/organizations/{org_id}

org_id

string

required

The ID of the organization to retrieve.

Update an organization

PUT /api/v1/organizations/{org_id} Replaces the organization’s mutable fields. Include all fields you want to retain, not just the ones you are changing.

org_id

string

required

The ID of the organization to update.

name

string

required

Updated display name.

country

string

required

Updated ISO 3166-1 alpha-2 country code.

contact_email

string

required

Updated contact email address.

Members

List members

GET /api/v1/organizations/{org_id}/members

org_id

string

required

The organization ID.

curl https://api.dynamo-csms.com/api/v1/organizations/org_01HX7A3B2C4D5E6F/members \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "data": [
    {
      "user_id": "usr_01HX8B4C3D5E6F7G",
      "email": "alice@greenway.example.com",
      "name": "Alice Chen",
      "role": "admin",
      "joined_at": "2024-01-20T09:15:00Z"
    },
    {
      "user_id": "usr_01HX8B4C3D5E6F8H",
      "email": "bob@greenway.example.com",
      "name": "Bob Singh",
      "role": "viewer",
      "joined_at": "2024-01-21T11:00:00Z"
    }
  ],
  "total": 2
}

Update a member’s role

PUT /api/v1/organizations/{org_id}/members/{user_id}/role

org_id

string

required

The organization ID.

user_id

string

required

The ID of the member whose role you are changing.

role

string

required

The new role. One of "admin", "member", or "viewer".

curl -X PUT https://api.dynamo-csms.com/api/v1/organizations/org_01HX7A3B2C4D5E6F/members/usr_01HX8B4C3D5E6F8H/role \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"role": "member"}'

Remove a member

DELETE /api/v1/organizations/{org_id}/members/{user_id}

org_id

string

required

The organization ID.

user_id

string

required

The ID of the member to remove.

Returns 204 No Content on success.

Invitations

Invite a member

POST /api/v1/organizations/{org_id}/invitations Sends an email invitation to join your organization with the specified role.

org_id

string

required

The organization ID.

string

required

Email address of the person to invite.

role

string

required

Role to assign on acceptance: "admin", "member", or "viewer".

curl -X POST https://api.dynamo-csms.com/api/v1/organizations/org_01HX7A3B2C4D5E6F/invitations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "charlie@example.com",
    "role": "member"
  }'

{
  "id": "inv_01HXC5D4E3F2G1H0",
  "email": "charlie@example.com",
  "role": "member",
  "expires_at": "2024-01-27T09:00:00Z",
  "created_at": "2024-01-20T09:00:00Z"
}

Accept an invitation

POST /api/v1/organizations/invitations/accept The invited user calls this endpoint with the token from their invitation email.

token

string

required

The invitation token from the invitation email.

curl -X POST https://api.dynamo-csms.com/api/v1/organizations/invitations/accept \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"token": "inv_tok_abc123xyz"}'

Cancel an invitation

DELETE /api/v1/organizations/{org_id}/invitations/{invitation_id}

org_id

string

required

The organization ID.

invitation_id

string

required

The ID of the invitation to cancel.

Returns 204 No Content on success.

Organization settings

Get settings

GET /api/v1/organizations/{org_id}/settings

org_id

string

required

The organization ID.

curl https://api.dynamo-csms.com/api/v1/organizations/org_01HX7A3B2C4D5E6F/settings \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "org_id": "org_01HX7A3B2C4D5E6F",
  "default_currency": "GBP",
  "timezone": "Europe/London",
  "billing_email": "billing@greenway.example.com",
  "notification_preferences": {
    "alert_emails": true,
    "weekly_report": true
  }
}

Update settings

PUT /api/v1/organizations/{org_id}/settings

org_id

string

required

The organization ID.

default_currency

string

ISO 4217 currency code (e.g., "GBP", "EUR", "USD").

timezone

string

IANA timezone name (e.g., "Europe/London").

billing_email

string

Email address for billing-related notifications.

notification_preferences

object

Object controlling which notifications the organization receives.

Site owner

Site owners are external partners or property managers who host charge points on your network. These endpoints manage their onboarding flow and profile.

Accept a site owner invitation

POST /api/v1/site-owner/accept-invitation/{token}

token

string

required

The site owner invitation token from the invitation email.

Get onboarding status

GET /api/v1/site-owner/onboarding/status Returns the current stage of the site owner onboarding process.

curl https://api.dynamo-csms.com/api/v1/site-owner/onboarding/status \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "stage": "documents_pending",
  "completed_steps": ["profile", "bank_details"],
  "pending_steps": ["documents", "approval"]
}

Complete onboarding

POST /api/v1/site-owner/onboarding/complete Signals that the site owner has submitted all required information.

Get site owner profile

GET /api/v1/site-owner/profile Returns profile and account details for the authenticated site owner.

List site owner projects

GET /api/v1/site-owner/projects Returns all charging projects associated with this site owner.

curl https://api.dynamo-csms.com/api/v1/site-owner/projects \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "data": [
    {
      "id": "proj_01HXD6E5F4G3H2I1",
      "name": "Canary Wharf Car Park",
      "charge_point_count": 12,
      "status": "active"
    }
  ],
  "total": 1
}

Driver portal

The driver portal lets EV drivers view their own session history and manage billing disputes without needing access to the operator API.

List driver sessions

GET /api/v1/portal/sessions Returns all charging sessions for the authenticated driver.

from

string

Start of date range (ISO 8601).

string

End of date range (ISO 8601).

limit

number

default:"20"

Number of sessions to return (max 100).

curl "https://api.dynamo-csms.com/api/v1/portal/sessions?from=2024-01-01&to=2024-01-31" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "data": [
    {
      "session_id": "sess_01HXE7F6G5H4I3J2",
      "charge_point_id": "cp_001",
      "started_at": "2024-01-15T08:30:00Z",
      "ended_at": "2024-01-15T09:45:00Z",
      "energy_kwh": 22.4,
      "cost": 7.84,
      "currency": "GBP"
    }
  ],
  "total": 1
}

Get session cost breakdown

GET /api/v1/portal/sessions/{session_id}/cost-breakdown

session_id

string

required

The session ID.

Returns an itemised breakdown of session charges including energy, time, and any applicable fees.

Download session receipt

GET /api/v1/portal/sessions/{session_id}/receipt

session_id

string

required

The session ID.

Returns a PDF receipt for the session. The response Content-Type is application/pdf.

Submit a billing dispute

POST /api/v1/portal/sessions/{session_id}/dispute

session_id

string

required

The session ID to dispute.

reason

string

required

Description of the issue with the charge.

expected_cost

number

What the driver believes the correct cost should be.

curl -X POST https://api.dynamo-csms.com/api/v1/portal/sessions/sess_01HXE7F6G5H4I3J2/dispute \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Session ended prematurely but full session duration was charged.",
    "expected_cost": 3.50
  }'

{
  "dispute_id": "disp_01HXF8G7H6I5J4K3",
  "session_id": "sess_01HXE7F6G5H4I3J2",
  "status": "open",
  "created_at": "2024-01-20T14:00:00Z"
}

Reservations

Reservations let drivers hold a connector before they arrive, reducing the chance of finding no available charger.

Create a reservation

POST /api/v1/reservations

charge_point_id

string

required

The charge point to reserve a connector on.

connector_id

number

required

The connector number to reserve.

expiry_date

string

required

ISO 8601 datetime at which the reservation expires if unused.

id_tag

string

required

The driver’s ID tag (RFID UID or email). Only this tag can use the reservation.

curl -X POST https://api.dynamo-csms.com/api/v1/reservations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "charge_point_id": "cp_001",
    "connector_id": 1,
    "expiry_date": "2024-01-20T16:00:00Z",
    "id_tag": "driver@example.com"
  }'

{
  "reservation_id": "res_01HXG9H8I7J6K5L4",
  "charge_point_id": "cp_001",
  "connector_id": 1,
  "id_tag": "driver@example.com",
  "expiry_date": "2024-01-20T16:00:00Z",
  "status": "active",
  "created_at": "2024-01-20T14:30:00Z"
}

List reservations

GET /api/v1/reservations

charge_point_id

string

Filter reservations by charge point.

status

string

Filter by status: active, used, expired, or cancelled.

Cancel a reservation

DELETE /api/v1/reservations/{reservation_id}

reservation_id

string

required

The ID of the reservation to cancel.

Returns 204 No Content on success. Cancellation sends a CancelReservation command to the charge point via OCPP.

​Authentication

​Organizations

​Create an organization

​Get an organization

​Update an organization

​Members

​List members

​Update a member’s role

​Remove a member

​Invitations

​Invite a member

​Accept an invitation

​Cancel an invitation

​Organization settings

​Get settings

​Update settings

​Site owner

​Accept a site owner invitation

​Get onboarding status

​Complete onboarding

​Get site owner profile

​List site owner projects

​Driver portal

​List driver sessions

​Get session cost breakdown

​Download session receipt

​Submit a billing dispute

​Reservations

​Create a reservation

​List reservations

​Cancel a reservation

Authentication

Organizations

Create an organization

Get an organization

Update an organization

Members

List members

Update a member’s role

Remove a member

Invitations

Invite a member

Accept an invitation

Cancel an invitation

Organization settings

Get settings

Update settings

Site owner

Accept a site owner invitation

Get onboarding status

Complete onboarding

Get site owner profile

List site owner projects

Driver portal

List driver sessions

Get session cost breakdown

Download session receipt

Submit a billing dispute

Reservations

Create a reservation

List reservations

Cancel a reservation