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 Companies API

The companies in the Vic system.

Vic.ai Companies 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 Companies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 23 operations across 15 paths, and defines 47 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.

23 operations 15 paths 47 schemas 2 DELETE10 GET2 PATCH7 POST2 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 Companies API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 23

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

Companies 23

The companies in the Vic system.

POST
/v2/organizations/{organization_id}/companies
Create a company under an organization
createOrganizationCompanyV2 1 param body → 2014XX
GET
/v2/companies
Search and list companies accessible
listCompaniesV2 3 params → 2004XX
POST
/v2/companies
Create a company
createCompanyV2 body → 2014XX
GET
/v2/companies/{company_id}/tags
List a company's tags
listCompanyTagsV2 1 param → 2004XX
POST
/v2/companies/{company_id}/tags
Assign a tag to a company
createCompanyTagV2 1 param body → 2014XX
GET
/v2/companies/{company_id}
Get a company
getCompanyV2 1 param → 2004XX
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
PUT
/v2/companies/{company_id}/fields/{field_label}/options
Manage company custom field options
updateCompanyFieldOptionsV2 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/companies/{company_id}/invoice_approval_flows
List invoice approval flows
listInvoiceApprovalFlowsV2 2 params → 2004XX
POST
/v2/companies/{company_id}/invoice_approval_flows
Create an invoice approval flow
createInvoiceApprovalFlowV2 1 param body → 2014XX
GET
/v2/companies/{company_id}/invoice_approval_flows/{id}
Get an invoice approval flow
getInvoiceApprovalFlowV2 2 params → 2004044XX
PUT
/v2/companies/{company_id}/invoice_approval_flows/{id}
Update an invoice approval flow
updateInvoiceApprovalFlowV2 2 params body → 2004044XX
DELETE
/v2/companies/{company_id}/invoice_approval_flows/{id}
Delete an invoice approval flow
deleteInvoiceApprovalFlowV2 2 params → 2044044XX
GET
/v2/companies/{company_id}/settings
Get company settings
getCompanySettingsV2 1 param → 2004XX
PATCH
/v2/companies/{company_id}/settings
Update company settings
updateCompanySettingsV2 1 param body → 2004XX
GET
/v2/companies/{company_id}/webhook/events
List webhook events by company
listCompanyWebhookEventsV2 7 params → 2004XX
GET
/v2/companies/{company_id}/webhook/events/{event_id}
Get a webhook event by company
getCompanyWebhookEventV2 2 params → 2004044XX

Schemas 47

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

WebhookEventsListV2
object
2 properties 2 required
WebhookEvent
object
5 properties 5 required
InvoiceApprovalFlowV2
object
9 properties
CompanyFieldOptionsUpdateRequestV2
object
2 properties 1 required
LanguageV2
string
The two letter code for the language used.
InvoiceApprovalFlowApproverSelectionRuleV2
object
4 properties
WebhookEventTypeName
string
A webhook event type.
CreateCompanyUserV2
InvoiceApprovalFlowStepReminderNotificationV2
object
4 properties
ErrorString
string
InvoiceApprovalFlowApproverSelectionRuleValueV2
object
4 properties
UpdateCompanySettingsV2
object
Partial update for company settings. All fields are optional; only fields included in the body are modified. Shape and types mirror CompanySettingsV2. Unknown…
16 properties
CountryCode
string
The ISO-3166 country code. The acceptable values are Alpha-2 codes.
InvoiceApprovalFlowStepInputV2
object
9 properties 1 required
AttachUserToCompanyV2
object
2 properties
CreateCompanyTagV2
object
1 property 1 required
WebhookEventV2
object
1 property 1 required
CreatedCompanyV2
object
Sparse company payload returned at company creation time (by POST /v2/companies or POST /v2/organizations/{organizationid}/companies). It carries the same iden…
6 properties 2 required
InvoiceApprovalFlowSelectionRuleValueV2
object
9 properties
UserStatusV2
string
The type of invoice item line.
CompanyTagV2
object
1 property 1 required
CompanyV2
object
6 properties 1 required
CompanyUserRoleV2
string
CreateUserV2
object
10 properties 2 required
ErrorV2
object
2 properties 1 required
InvoiceApprovalFlowStepReminderNotificationInputV2
object
3 properties 2 required
InvoiceApprovalFlowSelectionRuleV2
object
7 properties
PaginationV2
object
2 properties
CompanyUserMetaV2
object
4 properties
InvoiceApprovalFlowSelectionRuleInputV2
object
5 properties 4 required
UserV2
object
A User attached to an organization.
16 properties 3 required
InvoiceApprovalFlowStepV2
object
9 properties
UpdateCompanyUserRolesV2
object
1 property 1 required
InvoiceApprovalFlowInputV2
object
Creating a Flow with Selection Rules When you create an approval flow (see the main invoice approval flow endpoint documentation for the request/response contr…
7 properties 5 required
UserAddressV2
object
5 properties
TimeZoneV2
string
UserMetadataEntryV2
object
3 properties
CreateCompanyV2
object
8 properties 3 required
InvoiceApprovalFlowSelectionRuleValueInputV2
object
7 properties 1 required
InvoiceApprovalFlowApproverSelectionRuleInputV2
object
2 properties 2 required
CompanyUserRolesV2
object
1 property 1 required
CompanySettingsV2
object
A company's configuration options. Every available setting is always present in the response. Enum values are returned as strings; booleans as booleans. null m…
16 properties 16 required
UserManagerV2
object
A user's manager.
3 properties 1 required
PaginationMetaV2
object
1 property
InvoiceApprovalFlowApproverSelectionRuleValueInputV2
object
2 properties 2 required
CompanyFieldOptionsResponseV2
object
1 property 1 required
Error
object
generic error message in JSON format. Note the 'code' field should match the HTTP status code of the wrapping HTTP request.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vicai-companies-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 Company Settings API
Vic.ai Credit Confirmations API
Vic.ai CSV Reports API
Vic.ai Dimensions API
Vic.ai Email Endpoints API
Vic.ai Invoice Approval Flows API
Where this information came from

This is an independent, third-party profile of Vic.ai Companies 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.