Vim Docs

Appearance

v1.0.0

Vim REST API​

The Vim REST API allows you to access various resources and services provided by Vim.
The API is based on the OAuth 2.0 protocol and uses the client credentials grant type for authentication.
Before calling any authenticated resource request, you must obtain an access token by calling the Obtain access token endpoint.

These docs are interactive, so you can change the request parameters and see the response in real-time. Try it out!

Servers​

https://api.getvim.com/v1

Authentication​

Obtain an access token​

POST
/oauth/token

Exchange your client credentials for an access token to be used when calling any authenticated resource request.

Request Body​

Responses​

Successful response

Samples​

cURL
curl -X POST https://api.getvim.com/v1/oauth/token
JavaScript
fetch("https://api.getvim.com/v1/oauth/token", { method: "POST" })
  .then(response => response.json())
  .then(data => console.log(data));
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.getvim.com/v1/oauth/token");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Python
import requests
response = requests.post("https://api.getvim.com/v1/oauth/token")
print(response.json())

Invitations​

Invite users to access your applications on Vim​

POST
/invitations

Invite users to access your applications on Vim.
The API creates an account and organization based on the provided data, activating the user under these entities.
The API returns an invitation URL that can be shared with the user for login and activation.
For authorization, you must use the token obtained from the Obtain access token endpoint.
Rate limit: You can send up to 10 requests per minute.

Authorizations​

Request Body​

Responses​

Organization and user created successfully

Samples​

cURL
curl -X POST https://api.getvim.com/v1/invitations
JavaScript
fetch("https://api.getvim.com/v1/invitations", { method: "POST" })
  .then(response => response.json())
  .then(data => console.log(data));
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.getvim.com/v1/invitations");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Python
import requests
response = requests.post("https://api.getvim.com/v1/invitations")
print(response.json())

Appointments​

Get future appointments data​

GET
/appointments/{vimOrganizationId}

Appointments public api enables Canvas’s app developers to get the clinic NPI’s future appointments as a back end API request.
The endpoint returns clinic’s scheduled appointments for the upcoming 7 days for all clinic’s providers.
For authorization, you must use the token obtained from the Obtain access token endpoint.

Rate limit: You can send up to 50 requests per minute.

Pagination: The API supports offset-based pagination to handle large datasets efficiently. The following parameters control pagination:

  • offset (optional): The starting point of the data to retrieve. Default is 0.
  • limit (optional): The number of records to retrieve. Default is 50, with a maximum value of 50.

This allows you to retrieve subsets of data in sequential requests. For example:

  • offset=0&limit=50 retrieves the first 50 records.
  • offset=50&limit=50 retrieves the next 50 records.

Vim allows developers to test the API without accessing live data. By using vimOrganizationId = 123456789 in the API parameter, developers receive a predefined JSON response that simulates real appointment data but with de-identified data. Please note that you have to be authorized to use the service.

Authorizations​

Parameters​

Path Parameters

vimOrganizationId*

The Vim unique identifier for the organization. Vim constrains the available information; Vim shares information from organizations where your application is installed.

Typestring
Required

Query Parameters

offset

The starting point of the data to retrieve. Default is 0.

Typeinteger
limit

The number of records to retrieve. Default is 50, with a maximum value of 50.

Typeinteger

Responses​

Successful response

Samples​

cURL
curl -X GET https://api.getvim.com/v1/appointments/{vimOrganizationId}
JavaScript
fetch("https://api.getvim.com/v1/appointments/{vimOrganizationId}")
  .then(response => response.json())
  .then(data => console.log(data));
PHP
file_get_contents("https://api.getvim.com/v1/appointments/{vimOrganizationId}");
Python
import requests
response = requests.get("https://api.getvim.com/v1/appointments/{vimOrganizationId}")
print(response.json())
Powered by VitePress OpenAPI