<aside> ⚠️

Sunset apis - do not use

This functionality has been temporarily sunset.

</aside>

Introduction

The reference is your key to a comprehensive understanding of the Vula API.

API Keys

Currently, there is no way to generate API keys without Vula employees manual intervention.

<aside> 🔑 You need an integration token to interact with Vula APIs. Request API keys from your Vula integration partner.

</aside>

Conventions

The base URL to send all API requests is https://api.vula.vc/developers/

HTTPS is required for all API requests.

Requests follow  GET, POST, PATCH, and DELETE request types.

Request and response bodies are encoded as JSON.

JSON CONVENTIONS

• Top-level resources are addressable by a UUIDv4 "id" property. You may omit dashes from the ID when making requests to the API, e.g. when copying the ID from a Notion URL.
• Property names are in snake_case (not camelCase or kebab-case).

Request Limits

To ensure a consistent developer experience for all API users, the Notion API is rate limited and basic size limits apply to request parameters.

Rate Limits

Rate-limited requests will return a "rate_limited" error code (HTTP response status 429). The rate limit for incoming requests per integration is an average of three requests per second. Some bursts beyond the average rate are allowed.

Request timeouts

To ensure smooth traffic all our endpoints will terminate after 30s. Currently, these are flagged as 500s.

Versioning Headers

Our API versions are named for the date the version is released. For example, our latest version is 2023-10-03.

You set the version by including a vula-api-version header, and it must be set for each request.

curl https://api.vula.vc/developers/companies/01da9b00-e400-4959-91ce-af55307647e5 \
  -H "vula-api-version: 2023-10-03"

Company access flow

Vula strongly enforces data privacy and control laws - working under GDPR. As such, data minimisation and data deletion are clear proponents of the laws.

• Data minimisation - only request what is needed in processing. Data for future features or potential ideas falls below this bar.
• Data deletion - when a user requests an account deletion, Vula will call an agreed API to notify your business of a deletion request. You must comply within 30 days.

Read more in our Data Processing Agreement in Principle.

To gain access to companies data, partners should:

• reach out to their Vula representative wanting to ‘Create a DPA’ - a data processing agreement
• Vula will help draft a data processing agreement for you and the companies that is clear for all parties, aligns to data security standards, and is completed rapidly.
• Once formalised, the companies can then be prompted to grant access to the data requestor via a link such as vula.vc/claim?vula_claim_code=abcd-1234
  • URL preview
• Once the user has accepted the terms of the DPA,
  • you will have access to their data via the api
    • their company id will appear in your list of accessible
  • The user can be redirected to a URL you define with us, with a company id associated using a URL param vula_ref
    • https://{YOUR_URL}?vula_ref={GUID_COMPANY_ID}

POSTman collection

[coming soon]

Endpoints

Endpoints