How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vic.ai Users API

Managing users in the Vic system. You are allowed to add and remove users fromcompanies and organizations along with managing some of their attributes.However, you are not allowed edit a user's `email`. This is currently alimitation of the system.If a user is already created and you wish to add it to a company ororganization, use the following operations to add them.* `POST /v2/organizations/{organization_id}/users/attach`* `POST /v2/companies/{company_id}/users/attach`

Vic.ai Users API is one of 33 APIs that Vic.ai 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, API documentation, and an API reference.

This API exposes 14 operations across 10 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version v10.40.4.

Requests are made against 3 base URLs: https://api.no.stage.vic.ai, https://api.us.vic.ai, https://api.no.vic.ai.

14 operations 10 paths 21 schemas 2 DELETE5 GET1 PATCH5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v10.40.4
Base URL
https://api.us.vic.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 14

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

Users 14

Managing users in the Vic system. You are allowed to add and remove users from companies and organizations along with managing some of their attributes. However, you are not allow…

GET
/v2/organizations/{organization_id}/users
List users attached to an organization
listOrganizationUsersV2 6 params → 2004XX
POST
/v2/organizations/{organization_id}/users
Create and attach user to an organization
createOrganizationUserV2 1 param body → 2014XX
POST
/v2/organizations/{organization_id}/users/attach
Attach an existing user to an organization
attachUserToOrganizationV2 1 param body → 2014XX
DELETE
/v2/organizations/{organization_id}/users/{user_id}
Remove user from organization
removeUserFromOrganizationV2 2 params → 2044XX
GET
/v2/companies/{company_id}/users
List or search for users attached to the company
listCompanyUsersV2 6 params → 2004XX
POST
/v2/companies/{company_id}/users
Create and attach user to company
createCompanyUserV2 1 param body → 2014XX
POST
/v2/companies/{company_id}/users/attach
Attach an existing user to a company
attachUserToCompanyV2 1 param body → 2014XX
DELETE
/v2/companies/{company_id}/users/{user_id}
Remove user from company
removeUserFromCompanyV2 2 params → 2044XX
GET
/v2/companies/{company_id}/users/{user_id}/roles
List a user's roles in a company
listCompanyUserRolesV2 2 params → 2004XX
POST
/v2/companies/{company_id}/users/{user_id}/roles
Update a user's roles in a company
updateCompanyUserRolesV2 2 params body → 2004XX
PATCH
/v2/companies/{company_id}/users/{user_id}/manager
Set or clear a user's manager in a company
updateCompanyUserManagerV2 2 params body → 2004XX
GET
/v2/users
List users
listUsersV2 5 params → 2004XX
GET
/v2/users/{user_id}
Get a user
getUserV2 1 param → 2004XX
PUT
/v2/users/{user_id}
Update a user
updateUserV2 1 param body → 2004XX

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are UserV2 (16 properties), CreateUserV2 (10 properties), UpdateUserV2 (9 properties), UserAddressV2 (5 properties). Each schema is shown below with its type and property counts.

CompanyUserRoleV2
string
CreateUserV2
object
10 properties 2 required
UserMetadataEntryV2
object
3 properties
AttachUserToCompanyV2
object
2 properties
ErrorV2
object
2 properties 1 required
AttachUserToOrganizationV2
object
3 properties
CompanyUserRolesV2
object
1 property 1 required
PaginationV2
object
2 properties
CompanyUserMetaV2
object
4 properties
OrganizationUserMetaV2
object
4 properties
UserManagerV2
object
A user's manager.
3 properties 1 required
PaginationMetaV2
object
1 property
LanguageV2
string
The two letter code for the language used.
CreateCompanyUserV2
UserV2
object
A User attached to an organization.
16 properties 3 required
UserStatusV2
string
The type of invoice item line.
UpdateCompanyUserRolesV2
object
1 property 1 required
UpdateUserV2
object
9 properties 1 required
CountryCode
string
The ISO-3166 country code. The acceptable values are Alpha-2 codes.
UserAddressV2
object
5 properties
TimeZoneV2
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vicai-users-api-openapi.yml Raw ↑

Other APIs Vic.ai publishes across the network.

Vic.ai Accounts API
Vic.ai Allowed Senders API
Vic.ai Attachments API
Vic.ai Authentication API
Vic.ai Beta Features API
Vic.ai Bills API
Vic.ai Companies API
Vic.ai Company Settings API
Vic.ai Credit Confirmations API
Vic.ai CSV Reports API
Vic.ai Dimensions API
Vic.ai Email Endpoints API
Where this information came from

This is an independent, third-party profile of Vic.ai Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.