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

Vim Invitations API

REST endpoint for inviting users to access applications on Vim. OAuth 2.0 client-credentials authenticated.

Vim Invitations API is one of 6 APIs that Vim publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Invitations and User Management. The published artifact set on APIs.io includes an API reference, an OpenAPI specification, and rate-limit docs.

This API exposes 6 operations across 6 paths, organized into 5 resource areas, and defines 1 schema. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://api.getvim.com/v1.

6 operations 6 paths 1 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.getvim.com/v1
Authentication
HTTP Bearer
Resource Areas
5

Authentication & Security 1

Vim Invitations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (Access token).

  • Access token — Use this token in the Authorization header when calling any authenticated resource request

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 4 GET, 2 POST. They span 5 resource areas: Authentication, Invitations, Applications, Appointments, Chart Retrieval. Each is listed below with its method, path, parameters, and response codes.

Authentication 1
POST
/oauth/token
Obtain an access token
body → 200400401
Invitations 1
POST
/invitations
Invite users to access your applications on Vim
body → 201400401409429
Applications 2
GET
/applications/{applicationId}/organizations
Get Organizations by Application Id
getApplicationOrganizations 1 param → 200400404429500
GET
/applications/{applicationId}/organizations/{organizationId}/users
Get all organization application users
getApplicationUsersForOrganization 2 params → 200401403404429500
Appointments 1
GET
/appointments/{vimOrganizationId}
Get future appointments data
getFutureAppointments 3 params → 201400403429500
Chart Retrieval 1
GET
/chart-retrieval/download-url/{requestId}
Get download URL for chart retrieval request
getChartRetrievalDownloadURL 1 param → 200400401403429500

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is CreateInvitationDto (2 properties). Each schema is shown below with its type and property counts.

CreateInvitationDto
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vim-rest-api-openapi-original.json Raw ↑

Other APIs Vim publishes across the network.

Vim Canvas SDK (VimOS.js)
Vim Applications & Organizations API
Vim Appointments API
Vim Chart Retrieval API
Vim Data Source
Where this information came from

This is an independent, third-party profile of Vim Invitations 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.