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

Invendor UserProfiles API

The UserProfiles API from Invendor — 9 operation(s) for userprofiles.

Invendor UserProfiles API is one of 42 APIs that Invendor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 14 operations across 9 paths, and defines 23 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against the base URL https://api.invendor.com.

14 operations 9 paths 23 schemas 3 DELETE6 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.invendor.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Invendor UserProfiles API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 14

Across 9 paths, the API surfaces 14 operations — 3 DELETE, 6 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

UserProfiles 14
GET
/v1/UserProfiles
Returns all user groups
GetUserGroups 6 params → 200400401403
POST
/v1/UserProfiles
Create new user group
CreateUserGroup 1 param body → 201400422401403
GET
/v1/UserProfiles/{profileId}
Retruns selected user group details
GetUserGroupDetails 2 params → 200400401403
PUT
/v1/UserProfiles/{profileId}
Update selected user group details
UpdateUserGroupDetails 2 params body → 204400422401403
DELETE
/v1/UserProfiles/{profileId}
Delete selected user group
DeleteUserGroup 2 params → 204400401403
GET
/v1/UserProfiles/properties
Get the list of all the properties added to user groups
GetAllUsedUserProfileProperties 1 param → 200400401403
GET
/v1/UserProfiles/{profileId}/users
Returns users list assigned to selected user group
GetUserGroupUsers 7 params → 200400401403
POST
/v1/UserProfiles/{profileId}/users
Add users to selected user group
AddUserToUserGroup 2 params body → 204400401403
GET
/v1/UserProfiles/{profileId}/locations/available
Returns locations available to assign to a user group (not yet assigned)
GetAvailableLocationsForUserGroup 7 params → 200400401403
GET
/v1/UserProfiles/{profileId}/locations
Returns user group locations list
GetUserGroupLocations 7 params → 200400401403
POST
/v1/UserProfiles/{profileId}/locations
Save user group locations and operations
SaveUserGroupLocation 2 params body → 200400401403
DELETE
/v1/UserProfiles/{profileId}/locations/{locationId}
Delete user group location
DeleteUserGroupLocation 3 params → 204400401403
POST
/v1/UserProfiles/{profileId}/locations/{locationId}/operations
Add a single operation to user group location
CreateUserGroupLocationOperation 3 params body → 204400401403
DELETE
/v1/UserProfiles/{profileId}/locations/{locationId}/operations/{operationId}
Delete selected operation from user group location
DeleteUserGroupLocationOperation 4 params → 204400401403

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are UserResponse (16 properties), LocationResponse (9 properties), UserProfileDetailsResponse (7 properties), ProfileLocationOperationResponse (7 properties). Each schema is shown below with its type and property counts.

ProfileLocationResponsePagedResult
object
5 properties
LocationResponse
object
9 properties
UserProfileResponsePagedResult
object
5 properties
LocationOperationLock
object
2 properties
SessionScanEventEnum
integer
LocationOperationRequest
object
5 properties
UserProfileDetailsResponse
object
7 properties
UserResponse
object
16 properties
Error
object
2 properties
ProfileLocationOperationQuestionResponse
object
3 properties
CreateProfileLocationRequest
object
2 properties
LocationType
integer
CreateUserProfileRequest
object
3 properties
LocationResponsePagedResult
object
5 properties
UserResponsePagedResult
object
5 properties
LocationConsumptionType
integer
Int32ResourceCreatedResponse
object
1 property
ProfileLocationResponse
object
6 properties
UpdateUserProfileDetailsRequest
object
4 properties
ProfileLocationOperationResponse
object
7 properties
UserProfileResponse
object
5 properties
Door
object
2 properties
ApiErrorResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

invendor-userprofiles-api-openapi.yml Raw ↑

Other APIs Invendor publishes across the network.

Invendor Accounts API
Invendor Auth API
Invendor Barcodes API
Invendor Consumption API
Invendor DataJobs API
Invendor Devices API
Invendor Dimensions API
Invendor DimensionValues API
Invendor Doors API
Invendor DynamicScanContent API
Invendor ExtendedProperties API
Invendor FlagTypes API