Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cariqa Users API

The Users API from Cariqa — 2 operation(s) for users.

Cariqa Users API is one of 7 APIs that Cariqa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and a quickstart.

This API exposes 5 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0 (v1).

Requests are made against 2 base URLs: https://connect.cariqa.com, https://dev.connect.cariqa.com.

5 operations 2 paths 9 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0 (v1)
Base URL
https://connect.cariqa.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Cariqa Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JWT Authorization header using the Bearer scheme.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Users 5
GET
/api/v1/users/
List Users
users_list 3 params → 200403
POST
/api/v1/users/
Create User
users_create body → 201400403
GET
/api/v1/users/{user_id}/
Get User
users_retrieve 1 param → 200403404
PATCH
/api/v1/users/{user_id}/
Update User
users_partial_update 1 param body → 200400403404
DELETE
/api/v1/users/{user_id}/
Soft-delete User
users_destroy 1 param → 204400402403404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ConnectAPIUser (4 properties), PatchedConnectAPIUser (4 properties), PaginatedConnectAPIUserList (4 properties), Error (3 properties). Each schema is shown below with its type and property counts.

ErrorDetail
object
2 properties 2 required
PatchedConnectAPIUser
object
4 properties
PaginatedConnectAPIUserList
object
4 properties 2 required
LocaleEnum
string
en - EN de - DE
ErrorTypeEnum
string
validationerror - validationerror paymentmethoderror - paymentmethoderror paymenterror - paymenterror temporarylocked - temporarylocked alreadycharging - alrea…
Detail
object
400 status error message response serializer.
1 property 1 required
Error
object
3 properties 2 required
ConnectAPIUserCustomProperties
object
1 property
ConnectAPIUser
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cariqa-users-api-openapi.yml Raw ↑

Other APIs Cariqa publishes across the network.

Cariqa Billing Details API
Cariqa Charging Sessions API
Cariqa Debts API
Cariqa Invoices API
Cariqa Payments API
Cariqa Stations API