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

Xentral User API

User represents a Xentral account used to access other parts of the system.

Xentral User API is one of 90 APIs that Xentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 6 paths. It is described by OpenAPI 3.0.0, at version v0.1.

Requests are made against 2 base URLs: https://{xentralId}.xentral.biz, https://{domain}.

9 operations 6 paths 0 schemas 1 DELETE5 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v0.1
Base URL
https://xentral.xentral.biz
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Xentral User API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Bearer token obtained in POST /tokens endpoint or pregenerated in the system.

Paths & Operations 9

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

User 9

User represents a Xentral account used to access other parts of the system.

POST
/api/v1/users
Create user
user.create body → 201400401403415429
GET
/api/v1/usersdeprecated
List users
user.list 3 params → 200401403406429
GET
/api/v2/users
List users V2
user.list.v2 3 params → 200401403429
GET
/api/v1/users/{id}
View user
user.view 1 param → 200401403404406429
PATCH
/api/v1/users/{id}
Update user
user.update 1 param body → 204400403404415429
DELETE
/api/v1/users/{id}
Delete user
user.delete 1 param → 204403404429
GET
/api/v1/users/{id}/permissions
List user permissions
user.permission.view 1 param → 200403404406429
GET
/api/v1/users/{id}/actions/downloadPermissions
Download user permissions
user.actions.downloadPermissions 1 param → 200403404406429
POST
/api/v1/users/{id}/resetPassword/request
Request reset password email
user.reset-password 1 param → 204400401403404415429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xentral-user-api-openapi.yml Raw ↑

Other APIs Xentral publishes across the network.

Xentral Account API
Xentral Accounting Export API
Xentral AuthPlatform API
Xentral Collection API
Xentral Collective Bill API
Xentral Credit API
Xentral Credit Note API
Xentral Credit Note Tag API
Xentral CreditNote API
Xentral Customer Address API
Xentral Customer API
Xentral Customer - Contact Person API