Invendor Users API
The Users API from Invendor — 14 operation(s) for users.
The Users API from Invendor — 14 operation(s) for users.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/invendor-users-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: IO.Common Accounts Users API
version: '1.0'
servers:
- url: https://api.invendor.com
description: Base URL declared by the provider in apis.yml (roadmap#122).
security:
- OAuth2: []
tags:
- name: Users
paths:
/v1/Users/info:
get:
tags:
- Users
summary: Returns user info of a current user (authenticated)
operationId: Get UserInfo
parameters:
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UserInfoResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Users:
get:
tags:
- Users
summary: Returns all users based on the request
description: 'Sortable columns: id, username, firstName, lastName, fullName, profileName, email.'
operationId: Users list
parameters:
- name: ShowOnlyNotConfirmed
in: query
schema:
type: boolean
- name: Filter
in: query
schema:
type: string
- name: Page
in: query
schema:
type: integer
format: int32
- name: PageSize
in: query
schema:
type: integer
format: int32
- name: SortColumn
in: query
schema:
type: string
- name: SortOrder
in: query
schema:
type: string
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponsePagedResult'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
post:
tags:
- Users
summary: Creates a new user
operationId: Create user
parameters:
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
description: ''
content:
application/json-patch+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateUserRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateUserRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateUserRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateUserRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Int32ResourceCreatedResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'422':
description: Client Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Users/{userId}:
get:
tags:
- Users
summary: Retruns user details by id
operationId: Get user details by userid
parameters:
- name: userId
in: path
description: ''
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UserDetailsResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
put:
tags:
- Users
summary: Update user details
operationId: Update user
parameters:
- name: userId
in: path
description: ''
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
description: ''
content:
application/json-patch+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateUserDetailsRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateUserDetailsRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateUserDetailsRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateUserDetailsRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'422':
description: Client Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
delete:
tags:
- Users
summary: Delete user
operationId: Delete user
parameters:
- name: userId
in: path
description: ''
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Users/{username}:
get:
tags:
- Users
summary: Returns user details by username
operationId: Get user details by username
parameters:
- name: username
in: path
description: ''
required: true
schema:
type: string
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UserDetailsResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Users/properties:
get:
tags:
- Users
summary: Returns the list of all the properties added to the user groups
operationId: Get all user properties
parameters:
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
type: string
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Users/definedProperties:
get:
tags:
- Users
summary: Get the defined properties for users
operationId: Get defined properties for users
parameters:
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GetDefinedPropertyParametersResponse'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
post:
tags:
- Users
summary: Create new user property with parameters
operationId: Create user defined property with parameters
parameters:
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
description: ''
content:
application/json-patch+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateDefinedPropertyParametersRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateDefinedPropertyParametersRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateDefinedPropertyParametersRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/CreateDefinedPropertyParametersRequest'
responses:
'200':
description: Success
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Users/definedProperties/{id}:
put:
tags:
- Users
summary: Update existing user property with parameters
operationId: Update user defined property with parameters
parameters:
- name: id
in: path
description: Property parameter Id
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
description: ''
content:
application/json-patch+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateDefinedPropertyParametersRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateDefinedPropertyParametersRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateDefinedPropertyParametersRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateDefinedPropertyParametersRequest'
responses:
'200':
description: Success
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
delete:
tags:
- Users
summary: Delete existing user property with parameters
operationId: Delete user defined propety with parameters
parameters:
- name: id
in: path
description: Property parameter Id
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'200':
description: Success
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Users/definedProperties/bulk:
post:
tags:
- Users
summary: Bulk upsert/delete user properties with parameters
operationId: Create or update user defined propeties with parameters
parameters:
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
description: ''
content:
application/json-patch+json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/BulkUpsertDefinedPropertyParametersRequest'
application/json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/BulkUpsertDefinedPropertyParametersRequest'
text/json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/BulkUpsertDefinedPropertyParametersRequest'
application/*+json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/BulkUpsertDefinedPropertyParametersRequest'
responses:
'200':
description: Success
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Users/change-password:
post:
tags:
- Users
summary: Change user password
operationId: Change user password
parameters:
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
description: ''
content:
application/json-patch+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/ChangeUserPasswordRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/ChangeUserPasswordRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/ChangeUserPasswordRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/ChangeUserPasswordRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'422':
description: Client Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Users/{userId}/nfcid:
post:
tags:
- Users
summary: Create or update user NFCID. (This operation allows to change users "OWN" NFCID)
operationId: Create or update users NFCID
parameters:
- name: userId
in: path
description: User id
required: true
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
description: Request DTO
content:
application/json-patch+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateUsersNFCIDRequest'
application/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateUsersNFCIDRequest'
text/json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateUsersNFCIDRequest'
application/*+json; x-api-version=1.0:
schema:
$ref: '#/components/schemas/UpdateUsersNFCIDRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Users/{userId}/reset-mfa:
post:
tags:
- Users
summary: Reset MFA, User can reconfigure new authenticator app
operationId: User can reconfigure new authenticator
parameters:
- name: userId
in: path
description: Identity user id
required: true
schema:
type: string
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Users/bulk:
post:
tags:
- Users
summary: Bulk insert group users
operationId: Bulk insert users
parameters:
- name: groupId
in: query
description: ''
schema:
type: integer
format: int32
- name: Account
in: query
description: Account
schema:
title: Account
type: int
requestBody:
description: ''
content:
application/json-patch+json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/CreateUserRequest'
application/json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/CreateUserRequest'
text/json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/CreateUserRequest'
application/*+json; x-api-version=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/CreateUserRequest'
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/v1/Users/{userId}/password-reset-email:
post:
tags:
- Users
summary: Generate a user password reset link and send an email
parameters:
- name: userId
in: path
description: User ID
required: true
schema:
type: integer
format: int32
- name: redirectUrl
in: query
description: Optional redirect URL after password reset (defaults to Portal)
schema:
type: string
- name: Account
in: query
description: Account
schema:
title: Account
type: int
responses:
'200':
description: Success
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.common
/api/v1/Users/all:
get:
tags:
- Users
summary: Get all tenant users
parameters:
- name: AccountId
in: query
schema:
type: integer
format: int32
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UsersDTO'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
'403':
description: Forbidden
security:
- OAuth2:
- io.reporting
components:
schemas:
UpdateUsersNFCIDRequest:
type: object
properties:
nfcid:
type:
- string
- 'null'
additionalProperties: false
DefinedPropertyValueDTO:
type: object
properties:
value:
type:
- string
- 'null'
isRequired:
type: boolean
additionalProperties: false
UserResponse:
type: object
properties:
id:
type: integer
format: int32
username:
type:
- string
- 'null'
accountId:
type: integer
format: int32
profileId:
type: integer
format: int32
firstName:
type:
- string
- 'null'
lastName:
type:
- string
- 'null'
fullName:
type:
- string
- 'null'
readOnly: true
profileName:
type:
- string
- 'null'
identityId:
type:
- string
- 'null'
nfcid:
type:
- string
- 'null'
pin:
type:
- string
- 'null'
simpleUser:
type: boolean
isDashboardEnabled:
type: boolean
email:
type:
- string
- 'null'
emailConfirmed:
type: boolean
mfaEnabled:
type: boolean
additionalProperties: false
CreateDefinedPropertyParametersRequest:
type: object
properties:
key:
type:
- string
- 'null'
showOnReports:
type: boolean
useAsFilter:
type: boolean
isRequired:
type: boolean
accountId:
type:
- integer
- 'null'
format: int32
additionalProperties: false
UsersDTO:
type: object
properties:
username:
type:
- string
- 'null'
firstName:
type:
- string
- 'null'
lastName:
type:
- string
- 'null'
pin:
type:
- string
- 'null'
nfcId:
type:
- string
- 'null'
accontId:
type: integer
format: int32
accountName:
type:
- string
- 'null'
groupId:
type: integer
format: int32
groupName:
type:
- string
- 'null'
userProperties:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PropertyDTO'
additionalProperties: false
UpdateDefinedPropertyParametersRequest:
type: object
properties:
id:
type: integer
format: int32
key:
type:
- string
- 'null'
showOnReports:
type: boolean
useAsFilter:
type: boolean
isRequired:
type: boolean
accountId:
type:
- integer
- 'null'
format: int32
additionalProperties: false
UserInfoResponse:
type: object
properties:
id:
type: integer
format: int32
username:
type:
- string
- 'null'
accountId:
type: integer
format: int32
profileId:
type: integer
format: int32
firstName:
type:
- string
- 'null'
lastName:
type:
- string
- 'null'
fullName:
type:
- string
- 'null'
readOnly: true
profileName:
type:
- string
- 'null'
identityId:
type:
- string
- 'null'
nfcid:
type:
- string
- 'null'
pin:
type:
- string
- 'null'
simpleUser:
type: boolean
isDashboardEnabled:
type: boolean
email:
type:
- string
- 'null'
emailConfirmed:
type: boolean
mfaEnabled:
type: boolean
accounts:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UserProfileAccountResponse'
services:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UserServiceSubscriptions'
modules:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UserModuleListItem'
roles:
uniqueItems: true
type:
- array
- 'null'
items:
type: string
features:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FeatureResponse'
tenantId:
type: string
format: uuid
additionalProperties: false
PropertyDTO:
type: object
properties:
key:
type:
- string
- 'null'
value:
type:
- string
- 'null'
additionalProperties: false
UserProfileAccountResponse:
type: object
properties:
id:
type: integer
format: int32
accountCode:
type:
- string
- 'null'
accountName:
type:
- string
- 'null'
filteredItems:
type: boolean
isTenantPrimary:
type: boolean
isUserPrimary:
type: boolean
mfaEnabled:
type: boolean
tenantId:
type:
- string
- 'null'
format: uuid
integrationEnabled:
type: boolean
default:
type: boolean
additionalProperties: false
BulkUpsertDefinedPropertyParametersRequest:
type: object
properties:
id:
type:
- integer
- 'null'
format: int32
key:
type:
- string
- 'null'
showOnReports:
type: boolean
useAsFilter:
type: boolean
isRequired:
type: boolean
accountId:
type:
- integer
- 'null'
format: int32
additionalProperties: false
UserModuleListItem:
type: object
properties:
module:
type:
- string
- 'null'
permissions:
type:
- array
- 'null'
items:
type: string
additionalProperties: false
ChangeUserPasswordRequest:
type: object
properties:
password:
type:
- string
- 'null'
additionalProperties: false
UserResponsePagedResult:
type: object
properties:
pageSize:
type: integer
format: int32
readOnly: true
page:
type: integer
format: int32
readOnly: true
totalCount:
type: integer
format: int32
readOnly: true
filteredCount:
type: integer
format: int32
readOnly: true
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UserResponse'
readOnly: true
additionalProperties: false
GetDefinedPropertyParametersResponse:
type: object
properties:
id:
type: integer
format: int32
affinity:
$ref: '#/components/schemas/ExtendedPropertyAffinity'
key:
type:
- string
- 'null'
showOnReports:
type: boolean
useAsFilter:
type: boolean
isRequired:
type: boolean
accountId:
type:
- integer
- 'null'
format: int32
additionalProperties: false
UpdateUserDetailsRequest:
type: object
properties:
profileId:
type: integer
format: int32
firstName:
type:
- string
- 'null'
lastName:
type:
- string
- 'null'
email:
type:
- string
- 'null'
roles:
type:
- array
- 'null'
items:
type: string
pin:
type:
- string
- 'null'
ioid:
type:
- string
- 'null'
deprecated: true
nfcid:
type:
- string
- 'null'
twoFactorEnabled:
type: boolean
properties:
type:
- object
- 'null'
additionalProperties:
type: string
mfaEnabled:
type:
- boolean
- 'null'
isDashboardEnabled:
type: boolean
additionalProperties: false
ExtendedPropertyAffinity:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 14
- 15
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 31
- 33
- 34
- 35
- 81
- 100
- 101
- 102
- 103
- 104
- 105
- 200
- 201
- 210
- 211
- 220
- 230
- 240
- 241
- 300
- 310
- 311
- 400
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/invendor/refs/heads/main/openapi/invendor-users-api-openapi.yml