APICRMCompaniesGet Companies

Get Companies

List CRM companies in your organization. Send paginated=true for a paged response ({ items, total, page, pageSize, counts }) where each item includes customFieldValues keyed by custom tab ID; without it the endpoint returns a plain array of the newest 1,000 companies (lite=true returns fewer fields). Paged filters: search (name, industry, email, phone, address fields and custom field values), activeTab (all | my | ours | prospects, default all), filterType and filterIndustry (comma-separated lists), filterCreated (today | week | month | 3months), sortBy (name, industry, type, city, createdAt, updatedAt, email, phone, website, address, zip, country), sortDir (asc | desc, default desc). pageSize defaults to 25, max 100.

Created: September 16, 2026

Updated: September 16, 2026

Overview

GET

https://dashboard.vinsi.ai/api/crm/companies

Request

Headers

Content-Type

string

application/json

x-api-key

string

REQUIRED

Query Params

paginated

string

OPTIONAL

Example: true

page

string

OPTIONAL

Example: 1

pageSize

string

OPTIONAL

Example: 25

search

string

OPTIONAL

Example: acme

activeTab

string

OPTIONAL

Example: all

filterType

string

OPTIONAL

Example: prospect

filterIndustry

string

OPTIONAL

Example: Healthcare

filterCreated

string

OPTIONAL

Example: month

sortBy

string

OPTIONAL

Example: name

sortDir

string

OPTIONAL

Example: asc

lite

string

OPTIONAL

Example: false

Response

{5 items"items":[1 item0:{18 items"id":int318
"name":string"Acme Dental"
"industry":string"Healthcare"
"website":string"https://acme-dental.example.co..."
"phone":string"+15555550100"
"email":string"info@acme-dental.example.com"
"address":string"100 Main St"
"city":string"San Diego"
"state":string"CA"
"zip":string"92101"
"country":string"US"
"type":string"prospect"
"ownerId":string"cmexampleuser0000000000001"
"createdAt":string"2026-09-01T18:30:00.000Z"
"updatedAt":string"2026-09-01T18:30:00.000Z"
"primaryContactId":int1042
"logoUrl":null
"customFieldValues":{1 item"12":{1 item"Number of Locations":string"3"
}
}
}
]
"total":int1
"page":int1
"pageSize":int25
"counts":{4 items"my":int1
"all":int42
"ours":int12
"prospects":int30
}
}

Endpoint Explorer

Note: You must be already authenticated on https://dashboard.vinsi.ai/ to use this API tester.

GET

Headers

Content-Type: *

x-api-key: *

Query Params

paginated: *

page: *

pageSize: *

search: *

activeTab: *

filterType: *

filterIndustry: *

filterCreated: *

sortBy: *

sortDir: *

lite: *

Response

No response yet. Click Send to test the API.