API 4 Developer Guide

Getting Started

You need API credentials (username and password) to call API v4. Credentials are tied to a specific Ventures site.

• Development: use the credentials for the test_integration sandbox site provided by Ventures support.
• Production: request credentials for the live site you will operate on.

Note: Examples in this guide use the sandbox site. For production, replace the site name in the URL. For example, https://test_integration.venturesgo.com becomes https://myproductionsite.venturesgo.com.

Swagger Documentation

The Ventures API Documentation (Swagger) page lists every v4 endpoint, including a separate section for each supported object type (for example, Company, Contact, and Loan). Each endpoint shows its parameters, request body schema, required fields, allowed picklist values, a request example, and the response schema. You can also call endpoints directly from the page.

To open it:

1. Go to https://test_integration.venturesgo.com and log in.
2. Click the Ventures API Documentation link in the footer.

Pro Tip: Import the OpenAPI JSON file linked from the Swagger page into Postman to create a collection with every endpoint.

Test your Credentials

1. On the Swagger page, expand the token endpoint and click Try it out.
2. Enter test_integration for the client, plus your username and password.
3. Click Execute. A successful response looks like this:
   

To call other endpoints from the Swagger page, click the lock icon, paste the token, and click Authorize.

API URL

Send all API requests to:

https://api.venturesgo.com

Do not use your Ventures site URL for API calls. Use the site URL only to log in to Ventures or to view the Swagger page. For example, the token URL is https://api.venturesgo.com/api/v4/token.

Authorization

First, call the token endpoint with:

1. The Ventures site name (the sandbox is test_integration).
2. Your username.
3. Your password.

The endpoint returns a token. Pass the token as a bearer token in the Authorization header on all other calls:

curl -X 'GET' 'https://api.venturesgo.com/api/v4/objects/contact/list' -H 'accept: application/json' -H 'Authorization: ******'

Tokens expire after 60 minutes. When a token expires, call the token endpoint again to get a new one.

Objects Endpoints

Endpoints under /api/v4/objects provide CRUD operations for Ventures data objects. Some objects support extra operations, and some are read-only. The Swagger page lists the exact endpoints each object type supports. For example, Contact supports:

Method	Endpoint	Action
GET	/api/v4/objects/contact/list	List contacts
GET	/api/v4/objects/contact/{objectId}	Get a contact
POST	/api/v4/objects/contact	Create a contact
POST	/api/v4/objects/contact/{objectId}	Update a contact
DELETE	/api/v4/objects/contact/{objectId}	Delete a contact

Use each endpoint’s request schema and example on the Swagger page to build create and update requests. The schema shows required fields, data types, maximum lengths, and allowed picklist values.

The metadata endpoints are still available if you want to discover objects at runtime:

• /api/v4/objects (GET) returns the object types you can use.
• /api/v4/objects/{objectTypeName}/describe (GET) returns the object’s fields, endpoints, and a JSON example.

Note: We are always adding objects and fields to the API. If the data you need is not supported, contact Ventures support.

Viewing your Data in Ventures

To see how your API data looks in Ventures, log in to https://test_integration.venturesgo.com with your API credentials. From there you can view the loans, contacts, and companies you manage through the API. You can also create data in Ventures and read it back through the API.