Velaris Entity Management V2 API
The Entity Management V2 API from Velaris — 11 operation(s) for entity management v2.
OpenAPI Specification
openapi: 3.0.3
info:
title: Velaris Public Activity Entity Management V2 API
version: 1.0.0
description: The Velaris Public API for the AI Customer Success Platform. Manage organizations, accounts, contacts, opportunities, risks, custom objects, activities, notes, tickets, tasks, users, surveys and more. Base URL https://api.euw1.velaris.io. Converted by API Evangelist from the provider-published public Postman collection (https://developers.velaris.io/).
contact:
name: Velaris
url: https://www.velaris.io/
servers:
- url: https://api.euw1.velaris.io
description: EU-West-1 production
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Entity Management V2
paths:
/v2/organizations:
get:
operationId: getAllOrganizations
summary: Get All Organizations
tags:
- Entity Management V2
description: '<p>Supported query params</p>
<div class="click-to-expand-wrapper is-table-wrapper"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
<th>Max Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>after</td>
<td>integer</td>
<td>Use an integer to specify the starting point for pagination.</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td>limit</td>
<td>integer</td>
<td>The number of records to return. Default is 10, and the maximum is 100.</td>
<td>10</td>
<td>100</td>
</tr>
<tr>
<td>fields</td>
<td>string</td>
<td>Comma-separated field names to specify the fields to be included in the response. If both <code>fields</code> and <code>fieldIds</code> are provided, <code>fieldIds</code> takes priority.</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td>fieldIds</td>
<td>string</td>
<td>Comma-separated field IDs to specify the fields to be included in the response.</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td>archived</td>
<td>boolean</td>
<td>Use <code>true</code> or <code>false</code> to filter the results based on their archived status.</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td>churned</td>
<td>boolean</td>
<td>Use <code>true</code> or <code>false</code> to filter the results based on their churned status.</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td>externalId</td>
<td>string</td>
<td>Use a string to filter results based on the external ID.</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td>ownerId</td>
<td>integer</td>
<td>Use an integer to filter results based on the owner ID.</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td>lifecycleStageId</td>
<td>integer</td>
<td>Use an integer to filter results based on the lifecycle stage ID.</td>
<td>N/A</td>
<td>N/A</td>
</tr>
</tbody>
</table>
</div>'
responses:
'200':
description: OK
content:
application/json:
example:
data:
- organizationId: 1
imageId: null
about: null
externalId: 643e127855ecdeef8cd22b91-qualification-company
lifecycleStageId: 4
churned: 0
entityArchived: 0
scheduledChurn: 0
pulse: 4
globalFields:
name: Browsedrive
arr:
value: 1900
currencyDefinitionId: 5
renewal_date: '2024-04-24'
date_joined: '2024-04-18'
created: '2021-12-06T18:19:23.622Z'
modified: '2024-06-07T08:25:38.009Z'
createdBy: 1
modifiedBy: 5
accounts:
- 640
contacts: []
properties:
name: Browsedrive
address: Test1
date_joined: '2024-04-18'
renewal_date: '2024-04-24'
starting_saas_mrr:
currencyDefinitionId: 2
value: 2450
expansion_saas_mrr:
value: 3000
currencyDefinitionId: 5
total_saas_mrr:
value: 4633.333333333333
currencyDefinitionId: 5
starting_service_mrr:
currencyDefinitionId: 5
value: 2500
expansion_service_mrr:
value: 0
currencyDefinitionId: 5
total_service_mrr:
value: 2500
currencyDefinitionId: 5
total_mrr:
value: 7133.333333333333
currencyDefinitionId: 5
country: 6
csm: 18
license_count: 3
license_used: 20
software_mrr:
value: 12000
currencyDefinitionId: 5
wau: 1000
mau: 40
active_channels: 8
weekly_new_users: 24
monthly_new_users: 1
nps: -100
csat: 1
qbr_date: '2022-11-08'
strategic_customer: true
tier: 15
support_tier: 20
pricing_tier: 482
integrations: 3
nps_scored: '2021-09-25'
mrr:
value: 7133.333333333333
currencyDefinitionId: 5
mrr_2:
currencyDefinitionId: 5
value: 10000000
h_multi:
- 75
- 72
h_user: 267
h_single: 290
h_currency:
currencyDefinitionId: 5
value: 23
h_tf: false
h_con: 1652
h_multi_org:
- 290
true_false_attribute79: false
org_parent:
value: 0
currencyDefinitionId: 5
total_revenue:
value: 3000
currencyDefinitionId: 5
guides: 0
total_budget:
value: 0
currencyDefinitionId: 5
total_spent:
value: 0
currencyDefinitionId: 5
revenue:
value: 0
currencyDefinitionId: 5
revenue_captured:
value: 0
currencyDefinitionId: 5
currency_ab:
currencyDefinitionId: 5
value: 100
currency_attribute79:
currencyDefinitionId: 5
value: 1500
release_10_date: '2024-01-30'
release_10_numeric: 45.75
unique_text_attribute: abc12
unique_numeric_attribute: 1
ddd: 0
hii: 1045.75
bg: 0
testcur:
value: 0
currencyDefinitionId: 5
qa: false
acc: 1315
arr:
value: 1900
currencyDefinitionId: 5
ac_advanced_calc_copy: 1080.75
h_dynamic_multipick:
- 330
- 333
f123: 6457
seg_fix: 25
unique_text: abc123333
h__org: 253
newcalc41:
value: 100
currencyDefinitionId: 5
newhcal43:
value: 200
currencyDefinitionId: 5
cur12:
currencyDefinitionId: 5
value: 100
newvcal43: 0
neadvcalc43:
value: 10
currencyDefinitionId: 5
shayne_mrr:
value: 10017000
currencyDefinitionId: 5
zendesk_id: 8384099409169
owners:
- id: 6
ownerType: secondary
- id: 27
ownerType: primary
- organizationId: 2
imageId: null
about: null
externalId: hi
lifecycleStageId: 6
churned: 0
entityArchived: 0
scheduledChurn: 0
pulse: 3
globalFields:
name: Tekfly
arr:
value: 19000
currencyDefinitionId: 5
mrr:
currencyDefinitionId: 5
value: 2
renewal_date: '2024-04-19'
date_joined: '2018-06-09'
created: '2021-12-06T18:19:25.408Z'
modified: '2024-06-07T08:26:00.472Z'
createdBy: 1
modifiedBy: 5
accounts: []
contacts:
- 896
- 1749
properties:
name: Tekfly
date_joined: '2018-06-09'
renewal_date: '2024-04-19'
expansion_saas_mrr:
value: 0
currencyDefinitionId: 5
total_saas_mrr:
value: 0
currencyDefinitionId: 5
expansion_service_mrr:
value: 0
currencyDefinitionId: 5
total_service_mrr:
value: 0
currencyDefinitionId: 5
total_mrr:
value: 0
currencyDefinitionId: 5
country: 10
license_count: 185
services_mrr:
currencyDefinitionId: 5
value: 2
software_mrr:
currencyDefinitionId: 5
value: 4000
wau: 51
mau: 32
active_channels: 35
weekly_new_users: 1
monthly_new_users: 12
nps: 8
csat: 6
qbr_date: '2022-06-08'
strategic_customer: false
tier: 19
support_tier: 22
pricing_tier: 23
integrations: 3
nps_scored: '2021-09-22'
mrr:
value: 2
currencyDefinitionId: 5
mrr_2:
currencyDefinitionId: 5
value: 10000000
h_single: 288
h_tf: true
h_con: 1656
h_multi_org:
- 88
true_false_attribute79: false
org_parent:
value: 0
currencyDefinitionId: 5
total_revenue:
value: 0
currencyDefinitionId: 5
guides: 0
total_budget:
value: 0
currencyDefinitionId: 5
total_spent:
value: 0
currencyDefinitionId: 5
revenue:
value: 0
currencyDefinitionId: 5
revenue_captured:
value: 0
currencyDefinitionId: 5
currency_ab:
currencyDefinitionId: 5
value: 1000
currency_attribute79:
currencyDefinitionId: 5
value: 100.89
release_10_numeric: 45.75
unique_text_attribute: hi
unique_numeric_attribute: 123
ddd: 0
hii: 96.75
bg: 0
testcur:
value: 0
currencyDefinitionId: 5
acc: 915
arr:
value: 19000
currencyDefinitionId: 5
ac_advanced_calc_copy: 317.75
f123: 65784
seg_fix: 40
newcalc41:
value: 1000
currencyDefinitionId: 5
newhcal43:
value: 1300
currencyDefinitionId: 5
cur12:
currencyDefinitionId: 5
value: 300
newvcal43: 0
neadvcalc43:
value: 30
currencyDefinitionId: 5
shayne_mrr:
value: 10004000
currencyDefinitionId: 5
owners:
- id: 8
ownerType: secondary
- id: 436
ownerType: primary
- organizationId: 3
imageId: 5b311f964e6e1d01f9df4397995efebb1aa684fe/organizations/36424f90-2430-4e39-b25c-7b580c933d58.jpg
about: null
externalId: 643e127855ecdeef8cd22b90
lifecycleStageId: 1
churned: 1
entityArchived: 0
scheduledChurn: 0
pulse: 1
globalFields:
name: BMW M3
arr:
value: 3610
currencyDefinitionId: 5
mrr:
currencyDefinitionId: 5
value: 100
renewal_date: '2027-03-20'
date_joined: '2023-06-16'
created: '2021-12-06T18:19:27.025Z'
modified: '2024-04-11T12:40:28.397Z'
createdBy: 1
modifiedBy: 5
accounts:
- 35
- 69
contacts: []
churnData:
date: '2024-04-02'
reason: 10
properties:
name: BMW M3
address: test 283089
date_joined: '2023-06-16'
renewal_date: '2027-03-20'
expansion_saas_mrr:
value: 1250
currencyDefinitionId: 5
total_saas_mrr:
value: 1250
currencyDefinitionId: 5
expansion_service_mrr:
value: 0
currencyDefinitionId: 5
total_service_mrr:
value: 0
currencyDefinitionId: 5
total_mrr:
value: 1250
currencyDefinitionId: 5
sales_manager: 127
country: 3
csm: 24
license_count: 1024
license_used: 16798
services_mrr:
currencyDefinitionId: 5
value: 100
software_mrr:
value: 2450
currencyDefinitionId: 5
wau: 23100
mau: 22
active_channels: 0
weekly_new_users: 12
monthly_new_users: 19
nps: 67
csat: 8
qbr_date: '2023-05-31'
strategic_customer: false
tier: 18
support_tier: 20
pricing_tier: 482
integrations: 3
nps_scored: '2021-08-31'
mrr:
value: 1350
currencyDefinitionId: 5
seg_num: 5453
h_multi:
- 71
- 75
- 76
- 66
- 74
- 77
h_num: 7768
h_user: 267
h_currency:
currencyDefinitionId: 5
value: 1450
h_org: 936
h_multi_org:
- 173
h_multi_acc:
- 102
- 276
true_false_attribute79: true
multiscenario1:
- 643
- 359
- 391
- 215
- 173
- 205
hubspot_id_text: ''
org_parent:
value: 0
currencyDefinitionId: 5
total_revenue:
value: 1250
currencyDefinitionId: 5
guides: 0
total_budget:
value: 4000
currencyDefinitionId: 5
total_spent:
value: 0
currencyDefinitionId: 5
revenue:
value: 4000
currencyDefinitionId: 5
revenue_captured:
value: 0
currencyDefinitionId: 5
currency_ab:
currencyDefinitionId: 5
value: 190
currency_attribute79:
currencyDefinitionId: 64
value: 100000
project_manager: 446
release_10_date: '2023-12-29'
ro1: 209
ro2:
- 235
- 234
- 233
unique_text_attribute: abc1
unique_numeric_attribute: 12
ddd: 0
hii: 23100
bg: 0
testcur:
value: 0
currencyDefinitionId: 5
acc: 335960
arr:
value: 3610
currencyDefinitionId: 5
ac_advanced_calc_copy: 31904
f123: 100932
newcalc41:
value: 190
currencyDefinitionId: 5
owners:
- id: 234
ownerType: secondary
- id: 452
ownerType: primary
- organizationId: 4
imageId: 5b311f964e6e1d01f9df4397995efebb1aa684fe/organizations/05e333f0-8de8-473f-9632-52dcaeab2368.jpg
about: This is My about. 👀
externalId: '12312358907'
lifecycleStageId: 4
churned: 0
entityArchived: 0
scheduledChurn: 0
pulse: 4
globalFields:
name: Zoomcast + update
arr:
value: 0
currencyDefinitionId: 5
mrr:
currencyDefinitionId: 5
value: 100
renewal_date: '2027-03-20'
created: '2021-12-06T18:19:28.674Z'
modified: '2024-06-07T08:25:09.555Z'
createdBy: 1
modifiedBy: 5
accounts:
- 169
contacts:
- 504
- 1175
- 1408
- 6
properties:
'126': 100
name: Zoomcast + update
address: Test
renewal_date: '2027-03-20'
expansion_saas_mrr:
value: 0
currencyDefinitionId: 5
total_saas_mrr:
value: 0
currencyDefinitionId: 5
expansion_service_mrr:
value: 0
currencyDefinitionId: 5
total_service_mrr:
value: 0
currencyDefinitionId: 5
total_mrr:
value: 0
currencyDefinitionId: 5
sales_manager: 34
country: 2
csm: 462
license_count: 3
services_mrr:
currencyDefinitionId: 5
value: 100
software_mrr:
value: 7266.67
currencyDefinitionId: 5
wau: 23100
mau: 14
active_channels: 60
weekly_new_users: 24
monthly_new_users: 7
nps: -100
csat: 8
qbr_date: '2022-05-20'
strategic_customer: true
tier: 18
support_tier: 20
pricing_tier: 482
integrations: 2
nps_scored: '2021-09-04'
mrr:
value: 100
currencyDefinitionId: 5
seg_num: 667
mrr_2:
currencyDefinitionId: 5
value: 10000000
h_num: 7768
h_user: 267
h_single: 79
h_currency:
currencyDefinitionId: 5
value: 20
h_acc: 35
h_multi_org:
- 264
h_multi_acc:
- 288
- 410
true_false_attribute79: false
org_parent:
value: 0
currencyDefinitionId: 5
total_revenue:
value: 0
currencyDefinitionId: 5
guides: 0
total_budget:
value: 0
currencyDefinitionId: 5
total_spent:
value: 0
currencyDefinitionId: 5
revenue:
value: 0
currencyDefinitionId: 5
revenue_captured:
value: 0
currencyDefinitionId: 5
single_option_test: 201
user_attribute79: 6
currency_attribute79:
value: 100
currencyDefinitionId: 5
user_attribute79o: 470
project_manager: 447
release_10_user: 27
release_10_numeric: 45.75
ro1: 209
ro2:
- 235
- 234
- 233
unique_text_attribute: testing new changes
unique_numeric_attribute: 9090
ddd: 0
hii: 23145.75
bg: 0
testcur:
value: 0
currencyDefinitionId: 5
acc: 915
arr:
value: 0
currencyDefinitionId: 5
ac_advanced_calc_copy: 31000.75
multi_user:
- 464
- 451
- 456
- 370
unique_text: gfffd
newcalc41:
value: 0
currencyDefinitionId: 5
newhcal43:
value: 20.99
currencyDefinitionId: 5
cur12:
currencyDefinitionId: 5
value: 20.99
newvcal43: 0
neadvcalc43:
value: 2.0989999999999998
currencyDefinitionId: 5
shayne_mrr:
value: 10007266.67
currencyDefinitionId: 5
owners:
- id: 465
ownerType: primary
- organizationId: 5
imageId: null
about: null
externalId: '5'
lifecycleStageId: 6
churned: 0
entityArchived: 1
scheduledChurn: 0
pulse: null
globalFields:
name: Pixoboo
mrr:
currencyDefinitionId: 5
value: 7000
renewal_date: '2020-05-25'
date_joined: '2018-06-25'
created: '2021-12-06T18:19:30.330Z'
modified: '2022-06-08T00:43:50.039Z'
createdBy: 1
modifiedBy: 1
accounts: []
contacts: []
properties:
name: Pixoboo
date_joined: '2018-06-25'
renewal_date: '2020-05-25'
total_saas_mrr:
value: 0
currencyDefinitionId: 5
total_service_mrr:
value: 0
currencyDefinitionId: 5
total_mrr:
value: 0
currencyDefinitionId: 5
country: 3
license_count: 28
license_used: 23
services_mrr:
currencyDefinitionId: 5
value: 7000
software_mrr:
currencyDefinitionId: 5
value: 9000
wau: 16
mau: 95
active_channels: 37
weekly_new_users: 4
monthly_new_users: 15
nps: 1
csat: 2
qbr_date: '2022-01-13'
strategic_customer: true
tier: 18
support_tier: 22
pricing_tier: 24
integrations: 10
nps_scored: '2021-10-26'
mrr:
value: 16000
currencyDefinitionId: 5
owners: []
- organizationId: 6
imageId: null
about: null
externalId: '6'
lifecycleStageId: 6
churned: 0
entityArchived: 1
scheduledChurn: 0
pulse: null
globalFields:
name: Quire
mrr:
currencyDefinitionId: 5
value: 12000
renewal_date: '2019-02-01'
date_joined: '2017-10-30'
created: '2021-12-06T18:19:31.965Z'
modified: '2022-06-08T00:43:23.164Z'
createdBy: 1
modifiedBy: 1
accounts: []
contacts: []
properties:
name: Quire
date_joined: '2017-10-30'
renewal_date: '2019-02-01'
total_saas_mrr:
value: 0
currencyDefinitionId: 5
total_service_mrr:
value: 0
currencyDefinitionId: 5
total_mrr:
value: 0
currencyDefinitionId: 5
country: 6
license_count: 150
license_used: 27
services_mrr:
currencyDefinitionId: 5
value: 12000
software_mrr:
currencyDefinitionId: 5
value: 6000
wau: 53
mau: 91
active_channels: 25
weekly_new_users: 16
monthly_new_users: 7
nps: 8
csat: 7
qbr_date: '2022-02-10'
strategic_customer: false
tier: 19
support_tier: 22
pricing_tier: 23
integrations: 9
nps_scored: '2021-09-19'
mrr:
value: 18000
currencyDefinitionId: 5
owners: []
- organizationId: 7
imageId: 5b311f964e6e1d01f9df4397995efebb1aa684fe/organizations/a162dd41-39aa-425d-80b7-ecbbb5812d2f.jpg
about: null
externalId: '2312312323'
lifecycleStageId: 2
churned: 0
entityArchived: 0
scheduledChurn: 0
pulse: 4
globalFields:
name: Sky
arr:
value: 0
currencyDefinitionId: 5
mrr:
currencyDefinitionId: 64
value: 150
renewal_date: '2027-03-20'
date_joined: '2018-08-28'
created: '2021-12-06T18:19:33.587Z'
modified: '2024-06-07T08:25:40.051Z'
createdBy: 1
modifiedBy: 5
accounts: []
contacts: []
properties:
name: Sky
address: test2
date_joined: '2018-08-28'
renewal_date: '2027-03-20'
expansion_saas_mrr:
value: 0
currencyDefinitionId: 5
total_saas_mrr:
value: 0
currencyDefinitionId: 5
expansion_service_mrr:
value: 0
currencyDefinitionId: 5
total_service_mrr:
value: 0
currencyDefinitionId: 5
total_mrr:
value: 0
currencyDefinitionId: 5
sales_manager: 27
country: 9
csm: 462
license_count: 140
license_used: 10
services_mrr:
currencyDefinitionId: 64
valu
# --- truncated at 32 KB (944 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/velaris/refs/heads/main/openapi/velaris-entity-management-v2-api-openapi.yml