Gridex API
Build electricity retail websites, customer portals and backend integrations on one authoritative API. Gridex provides published offers, pricing, legal documents, customer and contract lifecycle state, customer portal data and signed webhooks. Your integration stays focused on the customer experience.
You do not need to match the latest documentation revision exactly to use a supported API version. Documentation updates do not change the business response schema or require an integration upgrade. Earlier supported V1 response profiles remain available; see the compatibility policy and migration guide. Independent Staff onboarding uses its own schema, 2026-10-05.2.
The API is available for integration development. Production use requires the deployed API and database prerequisites plus an active API credential for your organization, the required scopes and customer identity linking. Verify authenticated reads, writes, audit attribution and safe retries for the intended organization before go-live. A published specification or passing source checks do not by themselves qualify that organization's live business flow.
https://app.gridex.se/api/v1OpenAPI
https://app.gridex.se/api/v1/openapi/website-integration-v1.json
https://app.gridex.se/api/v1/openapi/customer-portal-v1.json
https://app.gridex.se/api/partner/v1Version 2026-08-17.1
OpenAPI
/api/partner/v1/openapi.json
1. Responsibilities
The integration boundary is deliberate: your application owns presentation and verified customer input; Gridex owns the authoritative electricity-retail business state and downstream processing.
Gridex platform
- Associates each API key with the correct organization, configuration and permissions.
- Publishes the offers, price options, legal documents and acceptance requirements available to customers.
- Resolves price areas and creates authoritative quotes, including applicable fees, markups and pricing rules.
- Validates applications and prevents duplicate business writes through idempotent processing.
- Creates and maintains the authoritative customer, site, contract, legal-acceptance and signature records.
- Assigns public application, customer and contract numbers and returns stable public references.
- Runs the configured supplier-switch and facility-information lifecycle, including downstream market communication where required.
- Tracks confirmation delivery, customer-visible lifecycle status, metering data and invoice data exposed by the enabled services.
Your integration
- Builds the website or application UI and keeps the Gridex API key on a trusted server only.
- Authenticates the end customer and sends a stable, verified customer identity from the server session.
- Displays Gridex-provided offer, quote and legal data without locally changing the authoritative calculation or document versions.
- Collects customer and site details, exact legal acceptance evidence and power-of-attorney evidence when required.
- Sends a stable
Idempotency-Keyfor every write and stores the returned public application number. - Uses documented response fields to drive the UI instead of interpreting internal processing states.
- Verifies webhook signatures, rejects stale requests and deduplicates deliveries before processing events.
2. Authentication
Use the API key only from your backend. Gridex identifies the correct organization from the credential, so requests do not need internal database identifiers or organization-selection fields.
GRIDEX_API_KEY=gridex_live_xxxxxxxxx
Authorization: Bearer $GRIDEX_API_KEYGRIDEX_API_KEY in browser JavaScript, a mobile application, logs, analytics events or client-visible environment variables.3. Website checkout
A production checkout should use Gridex as the source for the offer, price area, quote and legal documents. Submit the customer application only after the customer has accepted the exact published versions shown in the UI.
- Retrieve published offers with
GET /website/public-contracts. - Resolve the customer’s Swedish price area with
POST /website/energy-area/resolve. - Create the authoritative quote with
POST /website/quoteand validate it before final submission. - Retrieve the exact legal bundle with
GET /website/legal-bundleand display the required documents. - Collect the customer’s explicit acceptance evidence and power of attorney when required.
- Submit the application with one stable
Idempotency-Key.
Submit an application
POST https://app.gridex.se/api/v1/website/customer-applications
Authorization: Bearer $GRIDEX_API_KEY
Idempotency-Key: checkout_01JEXAMPLE000000000000000
Content-Type: application/json
{
"external_customer_id": "customer_12345",
"auth_user_id": "4f6d1e3a-1e84-4c3f-97be-03ac98f21916",
"customer_portal_user_id": "4f6d1e3a-1e84-4c3f-97be-03ac98f21916",
"offer_reference": "offer_variable_monthly",
"quote_reference": "quote_01JEXAMPLE000000000000000",
"price_option_reference": "variable_monthly_standard",
"invoice_delivery_method": "email",
"selected_component_references": [],
"site_count": 1,
"legal_bundle_version": "2026-08-19",
"legal_acceptances": [
{
"requirement_code": "agreement",
"document_reference": "legal_customer_document_example",
"document_version": "3",
"document_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"accepted": true,
"accepted_at": "2026-08-19T10:00:00.000Z"
},
{
"requirement_code": "power_of_attorney",
"document_reference": "legal_customer_document_poa_example",
"document_version": "2",
"document_hash": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"accepted": true,
"accepted_at": "2026-08-19T10:00:00.000Z"
}
],
"customer": {
"customer_type": "private",
"first_name": "Anna",
"last_name": "Andersson",
"personal_number": "19900101-1234",
"email": "anna@example.se",
"phone": "+46701234567"
},
"site": {
"street": "Example Street 1",
"postal_code": "11122",
"city": "Stockholm",
"country": "SE",
"annual_consumption_kwh": 4500
},
"powerOfAttorney": {
"accepted": true,
"scope": ["supplier_switch", "facility_information_lookup"],
"signerName": "Anna Andersson",
"signerIdentityNumber": "19900101-1234",
"method": "website_acceptance",
"acceptedAt": "2026-08-19T10:00:00.000Z",
"textVersionId": "00000000-0000-4000-8000-000000000001",
"ipAddress": "192.0.2.10",
"userAgent": "<customer browser user agent>"
}
}For automated power-of-attorney email, record the customer’s IP at acceptance and send it as powerOfAttorney.ipAddress from your trusted backend, with the original acceptedAt. Gridex creates a stable verification number and archives the accepted text, scopes and evidence as a PDF, with the verification number on every page. The IP of your API server is recorded separately. A form click or method: bankid does not prove a verified BankID signature. BankID is optional; missing evidence blocks external email until completed. Organization users can retrieve their organization’s PDFs in OPS under Fullmakter.
The legal references, hashes and versions in this example are placeholders. In production, copy the exact values returned by the legal-bundle endpoint. Do not generate or modify them locally.
Successful checkout response
The immediate customer-facing checkout result is returned in data.checkout. Use that object for the post-submit UI instead of deriving success from internal processing states.
{
"data": {
"application_number": "APP-2026-000123",
"customer_number": "DX-100123",
"contract_number": "AVT-100123",
"contract_status": "signed",
"signed_at": "2026-08-19T10:00:01.000Z",
"checkout": {
"outcome": "agreement_signed",
"thank_you_ready": true,
"page_state": "success",
"customer_action_required": false,
"application": {
"application_number": "APP-2026-000123",
"status": "accepted"
},
"agreement": {
"status": "signed",
"contract_number": "AVT-100123",
"signed_at": "2026-08-19T10:00:01.000Z",
"withdrawal_deadline_at": "2026-09-02T21:59:59.999999Z",
"signature_snapshot_sha256": "<sha256>"
},
"confirmation_email": {
"expected": true,
"status": "pending"
},
"status_path": "/api/v1/website/customer-applications/APP-2026-000123"
}
},
"request_id": "1eb19095-9fab-4c38-b6db-d28bd0e924d9",
"contract_schema_version": "2026-10-09.1"
}These illustrative timestamps show the deadline rule for newly signed qualifying private distance agreements: the end of the fourteenth calendar day after acceptance in Europe/Stockholm. Use the stored deadline returned by Gridex. Previously frozen agreements retain their recorded deadline; confirmation delivery does not change it.
checkout.thank_you_ready === true.success: the agreement is signed and no additional customer action is required.
success_action_required: the agreement is signed, but additional customer information is needed for downstream processing.
action_required: customer action is required before processing can continue.
processing: the application is accepted for processing; do not present it as a completed signed agreement unless the agreement fields confirm that state.
4. Status and lifecycle
Store application_number after a successful submission. Use the application status endpoint after redirects, page refreshes and later visits. It returns the authoritative customer-facing state of the agreement and downstream processing.
GET https://app.gridex.se/api/v1/website/customer-applications/APP-2026-000123
Authorization: Bearer $GRIDEX_API_KEY
{
"data": {
"application_number": "APP-2026-000123",
"status": "processing",
"contract_number": "AVT-100123",
"contract_status": "signed",
"signed_at": "2026-08-19T10:00:01.000Z",
"communication": {
"pending": false,
"sent": [
{ "event_type": "contract.confirmation_sent", "status": "delivered" }
]
},
"checkout": {
"thank_you_ready": true,
"page_state": "success",
"confirmation_email": { "expected": true, "status": "delivered" }
}
},
"request_id": "1eb19095-9fab-4c38-b6db-d28bd0e924d9",
"contract_schema_version": "2026-10-09.1"
}Agreement state and message-delivery state are separate. A confirmation email can still be queued while the agreement is already validly signed. Treat the documented delivery status as authoritative instead of assuming that an email was delivered because the agreement succeeded.
5. Customer Portal API
The Customer Portal API exposes only data belonging to the verified linked customer identity. Use granular scopes and request only the capabilities your portal needs. Available resources include profile data, contracts, sites, invoices, metering values, documents, legal acceptances, powers of attorney, events and notifications.
For customer sync, authenticated_user_reference is the authenticated account subject from your organization's login system. It must resolve an already linked active account in the API credential's organization. An unlinked, disabled or other-organization subject does not grant access or create a link.
Support cases and attachments
Your support page can open cases, exchange messages and attach files with the explicit customer_support.read and customer_support.write scopes. Your staff handle the same cases in OPS, including cases that continue over the phone. Only customer-visible messages and released files are returned; internal notes and staff-only files never are. Upload a file as the raw request body (application/pdf, image/png or image/jpeg, at most 4 MB) with an Idempotency-Key. Every file is quarantined and released only after a content check; rejected files return 422 attachment_rejected and are never served.
Verified customer login (optional)
Your organization can let Gridex verify the end customer's own login (OPS → Inställningar → Kundinloggning). Your server then forwards the login's signed assertion in x-gridex-customer-assertion: a compact JWS (RS256, PS256 or ES256) with your organization's iss and aud, sub = the linked portal user id, exp at most 15 minutes after iat and a unique jti. In report mode a missing or invalid assertion is only logged; when verification is required the API returns 403 customer_assertion_required or 403 customer_assertion_invalid. Organizations without a configuration are unaffected.
Archived powers of attorney: PDF and verification
List archived powers of attorney, verify the original file and let the customer download a verified PDF through your portal.
Access requirements
- A fresh, verified
x-gridex-customer-assertionand an active linked customer in the API key's organization. - Both scopes:
customer_power_of_attorney.readandcustomer_documents.read. - A configured identity provider. These requirements also apply in report mode; an unverified assertion does not authorize access.
Keep the API key and assertion on your trusted server. Offer the download only to the authenticated customer through your portal.
List, verify and download
- Find the archive. Call
GET /customer/powers-of-attorney/evidence. The statusarchived_unverifieddescribes metadata only; it does not verify the file. - Verify the original. Use the returned verification reference with
GET /customer/powers-of-attorney/evidence/{verificationReference}?format=json. The optionalsha256query compares your supplied digest. A mismatch returnssubmitted_sha256_matches: falsewithout changing the archive. - Download the PDF. Use the same endpoint with
format=pdfto download the verified PDF, up to 15 MiB.
What verification means
These GET requests never generate a PDF or create consent. Missing original IP or time evidence remains missing.
pdf_signature_validation: not_performed means that cryptographic PDF-signature and BankID validation have not been performed.
Full schemas, limits and error responses: current POA archive OpenAPI or pinned release 2026-10-19.1. Existing Website and Customer Portal contract releases are unchanged.
- GET
/api/v1/customer/consumption/sitesList linked customer sites and complete confirmed meter supply windows.
Required scope
customer_sites.read AND customer_metering.read - GET
/api/v1/customer/consumption/metering-valuesRead linked customer consumption intervals inside confirmed meter supply windows.
Required scope
customer_sites.read AND customer_metering.read - GET
/api/v1/customer/portal-bundleRetrieve the combined customer portal read model for a verified customer identity.
Required scope
customer_profile.read AND customer_sites.read AND customer_contracts.read AND customer_invoices.read AND customer_metering.read AND customer_legal.read AND customer_events.read AND customer_documents.read AND customer_notifications.read AND customer_power_of_attorney.read - POST
/api/v1/customer/portal-bundleRetrieve the combined customer portal read model for a verified customer identity.
Required scope
customer_profile.read AND customer_sites.read AND customer_contracts.read AND customer_invoices.read AND customer_metering.read AND customer_legal.read AND customer_events.read AND customer_documents.read AND customer_notifications.read AND customer_power_of_attorney.read - POST
/api/v1/customer-portal/syncLink or verify an external customer portal identity. Idempotency-Key is required.
Required scope
customer_sync.write - POST
/api/v1/customer/syncSubmit customer data required to complete an existing customer record or process. Idempotency-Key is required.
Required scope
customer_sync.write - GET
/api/v1/customer/meRetrieve the linked customer profile.
Required scope
customer_profile.read - GET
/api/v1/customer/contractsRetrieve the customer’s electricity contracts.
Required scope
customer_contracts.read - GET
/api/v1/customer/sitesRetrieve the customer’s electricity sites.
Required scope
customer_sites.read - GET
/api/v1/customer/invoicesRetrieve the customer’s invoices.
Required scope
customer_invoices.read - GET
/api/v1/customer/invoices/[id]Retrieve a single customer invoice.
Required scope
customer_invoices.read - GET
/api/v1/customer/metering-valuesRetrieve metering values available to the customer.
Required scope
customer_metering.read - GET
/api/v1/customer/eventsRetrieve customer-visible events.
Required scope
customer_events.read - GET
/api/v1/customer/documentsRetrieve customer documents without exposing internal storage paths.
Required scope
customer_documents.read - GET
/api/v1/customer/legal-acceptancesRetrieve the customer’s recorded legal acceptances.
Required scope
customer_legal.read - GET
/api/v1/customer/powers-of-attorney/evidenceList existing customer POA archives; requires a linked portal account and fresh verified customer assertion. Contract: /api/v1/openapi/poa-archive-v1.json.
Required scope
customer_power_of_attorney.read AND customer_documents.read - GET
/api/v1/customer/powers-of-attorney/evidence/[verificationReference]Verify or download an existing customer POA PDF by stored reference after checking its actual bytes; requires a linked portal account and fresh verified assertion. Contract: /api/v1/openapi/poa-archive-v1.json.
Required scope
customer_power_of_attorney.read AND customer_documents.read - GET
/api/v1/customer/powers-of-attorneyRetrieve the customer’s powers of attorney.
Required scope
customer_power_of_attorney.read - GET
/api/v1/customer/notificationsRetrieve customer notifications.
Required scope
customer_notifications.read - POST
/api/v1/customer/notifications/readMark customer notifications as read. Idempotency-Key is required.
Required scope
customer_notifications.write - POST
/api/v1/customer/profile-updateSubmit a customer contact or site-address update. Idempotency-Key is required.
Required scope
customer_contact.write OR customer_facility_data.write - GET
/api/v1/customer/support/casesList the customer’s support cases.
Required scope
customer_support.read - POST
/api/v1/customer/support/casesOpen a support case with the customer’s first message. Idempotency-Key is required.
Required scope
customer_support.write - GET
/api/v1/customer/support/cases/[reference]Retrieve a support case with its customer-visible messages.
Required scope
customer_support.read - GET
/api/v1/customer/support/cases/[reference]/messagesList customer-visible messages of a support case.
Required scope
customer_support.read - POST
/api/v1/customer/support/cases/[reference]/messagesAdd a customer message to an open support case. Idempotency-Key is required.
Required scope
customer_support.write - GET
/api/v1/customer/support/cases/[reference]/attachmentsList released, customer-visible attachments of a support case.
Required scope
customer_support.read - POST
/api/v1/customer/support/cases/[reference]/attachmentsUpload a customer attachment (raw PDF, PNG or JPEG body) to an open support case; content-checked before release. Idempotency-Key is required.
Required scope
customer_support.write - GET
/api/v1/customer/support/cases/[reference]/attachments/[attachmentReference]Download a released, customer-visible attachment; the SHA-256 is re-verified on every download.
Required scope
customer_support.read - POST
/api/v1/customer/move-outSubmit a customer move-out request. Idempotency-Key is required.
Required scope
customer_facility_data.write
6. Partner API
The Partner API is a streamlined backend-to-backend interface for integrations that need to create customers, sites and contracts, retrieve operational data or subscribe to contract-status changes. Gridex manages the account configuration and product mapping outside the API; the partner sends business data and uses the public references returned in responses.
Create a contract
POST https://app.gridex.se/api/partner/v1/contract
Authorization: Bearer $GRIDEX_API_KEY
Idempotency-Key: partner_contract_01JEXAMPLE000000000
Content-Type: application/json
{
"customer": {
"first_name": "Anna",
"last_name": "Andersson",
"soc_id": "19900101-1234",
"customer_type": "PRIVATE",
"email": "anna@example.se"
},
"site": {
"address": "Example Street 1",
"zip_code": "11122",
"city": "Stockholm",
"country": "SE",
"site_electricity_type": "CONSUMPTION"
},
"power_of_attorney": {
"poa_type": "WEB",
"transaction_type": "SWITCH",
"file_base64": "<pdf_base64>",
"file_extension": "pdf"
}
}Create a webhook subscription
POST https://app.gridex.se/api/partner/v1/webhook/subscription
Authorization: Bearer $GRIDEX_API_KEY
Idempotency-Key: partner_webhook_01JEXAMPLE000000000
Content-Type: application/json
{
"webhook_event": "CONTRACT_STATUS_CHANGE",
"target_url": "https://partner.example.com/webhooks/gridex",
"notification_email": "integration@example.com",
"signing_secret": "<at-least-32-random-characters>"
}- POST
/contractCreate contract
Required scope
Bearer API key - POST
/customerCreate customer
Required scope
Bearer API key - POST
/customer/{customer_id}/siteCreate site
Required scope
Bearer API key - GET
/customer/{customer_id}/site/{site_id}/powerofattorneyGet power of attorney
Required scope
Bearer API key - POST
/customer/{customer_id}/site/{site_id}/powerofattorneyUpload power of attorney
Required scope
Bearer API key - GET
/contract/{contract_id}/stateGet contract state
Required scope
Bearer API key - GET
/customer/{customer_id}Get customer
Required scope
Bearer API key - GET
/customer/{customer_id}/site/{site_id}Get site
Required scope
Bearer API key - GET
/customer/{customer_id}/site/{site_id}/invoiceList invoices for site
Required scope
Bearer API key - GET
/invoice/{invoice_id}Get invoice
Required scope
Bearer API key - GET
/invoice/{invoice_id}/pdfGet invoice PDF
Required scope
Bearer API key - GET
/customer/{customer_id}/site/{site_id}/measurementGet measurements
Required scope
Bearer API key - POST
/webhook/subscriptionCreate webhook subscription
Required scope
Bearer API key
7. Webhooks
Webhooks are signed change notifications. Verify the HMAC-SHA256 signature against the raw request body and timestamp, reject stale timestamps, and deduplicate by event or delivery identifier before applying side effects. When you need the latest complete state, use the webhook as a signal and retrieve the corresponding resource from Gridex.
POST https://partner.example.com/webhooks/gridex
X-Gridex-Timestamp: 1787130000
X-Gridex-Signature: sha256=<hmac_sha256>
X-Gridex-Event-ID: event_...
X-Gridex-Delivery-ID: delivery_...
Content-Type: application/json
{
"event_id": "event_...",
"event_type": "customer_application.status_changed",
"created_at": "2026-08-19T10:01:00.000Z",
"aggregate": {
"type": "website_customer_application",
"reference": "APP-2026-000123"
},
"data": {
"application_number": "APP-2026-000123",
"status": "processing",
"previous_status": "accepted"
},
"contract_schema_version": "2026-10-09.1"
}A temporary failure in your receiver does not change the underlying Gridex business event. Webhook delivery is retried independently according to the configured delivery policy.
8. Reliability and performance
Idempotency: every write that requires Idempotency-Key must reuse the same key only when retrying the exact same business request.
Caching: use ETag and If-None-Match for published offer feeds to avoid unnecessary transfers.
Checkout: use the POST response directly for the immediate success state instead of issuing a redundant status request.
Lifecycle updates: prefer signed webhooks when configured; use polling as a fallback with exponential backoff.
HTTP: reuse connections where your runtime supports it and keep all API calls server-to-server.
Observability: log the returned request_id with your own correlation identifier so support cases can be traced without exposing secrets or personal data.
9. Errors and retries
API errors use one structured envelope. Inspect error.code, error.retryable, error.field and error.blockers rather than parsing human-readable messages. Include request_id when contacting Gridex support about a failed request.
{
"error": {
"code": "validation_error",
"message": "The request could not be validated.",
"retryable": false,
"field": "customer.email",
"blockers": []
},
"request_id": "1eb19095-9fab-4c38-b6db-d28bd0e924d9",
"correlation_id": "1eb19095-9fab-4c38-b6db-d28bd0e924d9",
"contract_schema_version": "2026-10-09.1"
}10. Endpoint reference
This table shows the current integration endpoints. Historical immutable OpenAPI releases and internal diagnostics are intentionally omitted from the human-readable guide.
- GET
/api/v1/openapi/customer-consumption-v1.jsonIndependent customer consumption authority and metering contract.
Required scope
Public - GET
/api/v1/openapi/poa-archive-v1.jsonIndependent additive customer POA archive and verification contract.
Required scope
Public - GET
/api/v1/openapi/staff-onboarding-v1.jsonIndependent additive staff onboarding contract; separate from the frozen Staff API release.
Required scope
Public - POST
/api/v1/staff-onboarding/invitations/acceptExplicitly accept the registered client invitation with verified independent tenant Auth and a purpose-bound single-use signed assertion. Idempotency-Key is required.
Required scope
staff_users.write - POST
/api/v1/staff-onboarding/identity/resolveResolve an existing local-to-central staff identity binding using registered independent tenant Auth and a purpose-bound signed proof.
Required scope
staff_users.read - GET
/api/v1/openapi/staff-v1.jsonCurrent OpenAPI specification for staff integrations.
Required scope
Public - GET
/api/v1/openapi/release-manifest.jsonMachine-readable release manifest containing versions and SHA-256 digests for the public OpenAPI contracts.
Required scope
Public - GET
/api/v1/openapi/website-integration-v1.jsonCurrent OpenAPI specification for website integrations.
Required scope
Public - GET
/api/v1/openapi/customer-portal-v1.jsonCurrent OpenAPI specification for customer portal integrations.
Required scope
Public - GET
/api/v1/integration/contextVerify the authenticated API client and retrieve its public integration context.
Required scope
integration_context.read - GET
/api/v1/public-contractsRetrieve contracts published to the general API channel.
Required scope
api_contracts.read - GET
/api/v1/website/public-contractsRetrieve published electricity offers with complete pricing inputs and display rules.
Required scope
website_contracts.read - GET
/api/v1/website/portfolio-pricesRetrieve the public pricing method and sanitized historical final settlements for a published portfolio offer.
Required scope
website_contracts.read - POST
/api/v1/website/market-price/currentRetrieve the current normalized market price for a Swedish price area.
Required scope
website_market_prices.read - POST
/api/v1/website/quoteCreate an authoritative checkout quote from a published offer. Fixed products lock the energy price; market, portfolio and mixed products return indicative checkout evidence for the accepted pricing model. Idempotency-Key is required.
Required scope
website_quotes.write - POST
/api/v1/website/quote/validateValidate the immutable accepted quote and commercial identity. Elapsed wall-clock time alone does not invalidate an issued website quote.
Required scope
website_quotes.validate - POST
/api/v1/website/energy-area/resolveResolve the Swedish price area (SE1-SE4) for the supplied address or postal code.
Required scope
website_energy_area.resolve - GET
/api/v1/website/switch-statusRetrieve the current supplier-switch status using the public application number.
Required scope
website_switch_status.read - GET
/api/v1/website/legal-bundleRetrieve the exact published legal documents and versions required for customer acceptance.
Required scope
website_legal.read OR website_contracts.read - POST
/api/v1/website/customer-applicationsSubmit a customer application with the exact accepted offer, quote, legal evidence and customer data. Idempotency-Key is required.
Required scope
website_applications.write - GET
/api/v1/website/customer-applications/[application_number]Retrieve the authoritative status of an accepted customer application and its downstream processing.
Required scope
website_switch_status.read - POST
/api/v1/website/customer-eventsSubmit a customer event from a website or customer portal. Idempotency-Key is required.
Required scope
website_events.write - POST
/api/v1/eventsSubmit a customer-facing integration event. Idempotency-Key is required.
Required scope
website_events.write - GET
/api/v1/eventsRetrieve domain events available to the authenticated organization.
Required scope
events.read - GET
/api/v1/staff/usersList staff accounts with their membership status.
Required scope
staff_users.read - POST
/api/v1/staff/usersInvite staff to the organization within the acting staff role ceiling. Idempotency-Key is required.
Required scope
staff_users.write - PATCH
/api/v1/staff/users/[id]Change a staff role while preserving the final active administrator. Idempotency-Key is required.
Required scope
staff_users.write - POST
/api/v1/staff/users/[id]/disableDisable staff while preventing self disable and loss of the final administrator. Idempotency-Key is required.
Required scope
staff_users.write - POST
/api/v1/staff/users/[id]/enableReactivate a disabled staff membership. Idempotency-Key is required.
Required scope
staff_users.write - GET
/api/v1/staff/rolesList staff roles and whether the acting staff can assign each role.
Required scope
staff_users.read - GET
/api/v1/staff/customersSearch and page customers belonging to the authenticated organization.
Required scope
staff_customers.read - GET
/api/v1/staff/customers/[ref]Retrieve a customer with masked identity numbers and explicit public fields.
Required scope
staff_customers.read - PATCH
/api/v1/staff/customers/[ref]/contactUpdate customer contact fields using an expected version. Idempotency-Key is required.
Required scope
staff_customers.write - POST
/api/v1/staff/customers/[ref]/identity-changeRequest a customer identity change with customer approval when required. Idempotency-Key is required.
Required scope
staff_customers.write - GET
/api/v1/staff/casesList customer cases available to staff in the authenticated organization.
Required scope
staff_cases.read - POST
/api/v1/staff/casesCreate a customer support case as the acting staff. Idempotency-Key is required.
Required scope
staff_cases.write - GET
/api/v1/staff/cases/[reference]Retrieve a customer case including staff visible events and attachments.
Required scope
staff_cases.read - POST
/api/v1/staff/cases/[reference]/messagesReply to a customer through the existing support conversation. Idempotency-Key is required.
Required scope
staff_cases.write - POST
/api/v1/staff/cases/[reference]/notesAdd an internal staff note to a customer case. Idempotency-Key is required.
Required scope
staff_cases.write - POST
/api/v1/staff/cases/[reference]/phone-interactionsRecord a phone interaction and its customer verification evidence. Idempotency-Key is required.
Required scope
staff_cases.write - PATCH
/api/v1/staff/cases/[reference]/statusChange the status of a customer case. Idempotency-Key is required.
Required scope
staff_cases.write - PATCH
/api/v1/staff/cases/[reference]/assigneeAssign a customer case to active staff in the same organization. Idempotency-Key is required.
Required scope
staff_cases.write - GET
/api/v1/staff/cases/[reference]/eventsList staff visible case events with a case bound continuation cursor.
Required scope
staff_cases.read - GET
/api/v1/staff/cases/[reference]/attachmentsList staff visible attachments of a customer case.
Required scope
staff_cases.read - POST
/api/v1/staff/cases/[reference]/attachmentsUpload a staff attachment for content inspection before release. Idempotency-Key is required.
Required scope
staff_cases.write - GET
/api/v1/staff/cases/[reference]/attachments/[attachmentReference]/fileDownload a released staff visible attachment with its hash verified.
Required scope
staff_cases.read