logo
API docs by Redocly

Four/Four REST API (1.0.0)

Download OpenAPI specification:Download

This is the Four/Four API service located at https://fourfour.ai/odata. The service is intended to be used with business intelligence tools, but can also be called directly.

The service supports Basic authentication over HTTPS, and can be used by a user with a Conductor licence.

These OData feeds are compatible with business analysis tools such as PowerBI, Tableau and Excel.

Click here to get started with PowerBI.

Insights

Insights are the individual findings from each conversation. Insights are linked back to the conversation, participants and CRM objects. Insights are also grouped into Topics.

Get entities from Insights

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "type" "text" "category"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "topics" "leads" "opportunities" "contacts" "accounts" "owners" "conversations" "participants"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "type" "type desc" "text" "text desc" "category" "category desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entity from Insights by key

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "type" "text" "category"

Select properties to be returned, see OData Select

expand
Array of strings unique
Items Enum: "topics" "leads" "opportunities" "contacts" "accounts" "owners" "conversations" "participants"

Expand related entities, see OData Expand

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "text": "string",
  • "category": "string"
}

Get entities from related Topics

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "label" "description" "model_id" "model_index" "key_insight_ids"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "insights" "model" "key_insights" "leads" "accounts" "opportunities"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "label" "label desc" "description" "description desc" "model_id" "model_id desc" "model_index" "model_index desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Leads

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "title" "company" "email" "website" "lead_source" "status" "industry" "annual_revenue" "number_of_employees" "owner_id" "is_converted" "converted_date" "converted_account_id" "converted_contact_id" "converted_opportunity_id" "account_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "converted_account" "converted_contact" "converted_opportunity" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "title" "title desc" "company" "company desc" "email" "email desc" "website" "website desc" "lead_source" "lead_source desc" "status" "status desc" "industry" "industry desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "is_converted" "is_converted desc" "converted_date" "converted_date desc" "converted_account_id" "converted_account_id desc" "converted_contact_id" "converted_contact_id desc" "converted_opportunity_id" "converted_opportunity_id desc" "account_id" "account_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Opportunities

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "account_id" "description" "stage_name" "amount" "currency" "probability" "expected_revenue" "close_date" "type" "next_step" "lead_source" "is_closed" "is_won" "forecast_category" "forecast_category_name" "owner_id" "contact_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "contact" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "account_id" "account_id desc" "description" "description desc" "stage_name" "stage_name desc" "amount" "amount desc" "currency" "currency desc" "probability" "probability desc" "expected_revenue" "expected_revenue desc" "close_date" "close_date desc" "type" "type desc" "next_step" "next_step desc" "lead_source" "lead_source desc" "is_closed" "is_closed desc" "is_won" "is_won desc" "forecast_category" "forecast_category desc" "forecast_category_name" "forecast_category_name desc" "owner_id" "owner_id desc" "contact_id" "contact_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Contacts

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "account_id" "department" "lead_source" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "opportunities" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "email" "email desc" "title" "title desc" "account_id" "account_id desc" "department" "department desc" "lead_source" "lead_source desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Accounts

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "type" "parent_id" "website" "sic" "industry" "currency" "annual_revenue" "number_of_employees" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "parent" "contacts" "opportunities" "leads" "owner" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "type" "type desc" "parent_id" "parent_id desc" "website" "website desc" "sic" "sic desc" "industry" "industry desc" "currency" "currency desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Owners

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "opportunities" "accounts" "contacts" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "email" "email desc" "title" "title desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Conversations

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "service_id" "start" "end" "participant_count" "purpose"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "fragments" "participants" "accounts" "contacts" "leads" "opportunities" "owners"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "service_id" "service_id desc" "start" "start desc" "end" "end desc" "participant_count" "participant_count desc" "purpose" "purpose desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Participants

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "conversation_id" "service_id" "timestamp" "email" "name" "role"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Value: "fragments"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "conversation_id" "conversation_id desc" "service_id" "service_id desc" "timestamp" "timestamp desc" "email" "email desc" "name" "name desc" "role" "role desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Topics

Topics are groups of insights on a common theme.

Get entities from Topics

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "label" "description" "model_id" "model_index" "key_insight_ids"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "insights" "model" "key_insights" "leads" "accounts" "opportunities"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "label" "label desc" "description" "description desc" "model_id" "model_id desc" "model_index" "model_index desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entity from Topics by key

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "label" "description" "model_id" "model_index" "key_insight_ids"

Select properties to be returned, see OData Select

expand
Array of strings unique
Items Enum: "insights" "model" "key_insights" "leads" "accounts" "opportunities"

Expand related entities, see OData Expand

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "description": "string",
  • "model_id": "f8ff2fb8-4acc-4e48-bd83-cbdac23e1224",
  • "model_index": -9223372036854776000,
  • "key_insight_ids": [
    ]
}

Get entities from related Insights

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "type" "text" "category"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "topics" "leads" "opportunities" "contacts" "accounts" "owners" "conversations" "participants"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "type" "type desc" "text" "text desc" "category" "category desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related TopicModels

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "archived_at" "title" "description" "visibility" "status"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "topics" "insights"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "archived_at" "archived_at desc" "title" "title desc" "description" "description desc" "visibility" "visibility desc" "status" "status desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Insights

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "type" "text" "category"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "topics" "leads" "opportunities" "contacts" "accounts" "owners" "conversations" "participants"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "type" "type desc" "text" "text desc" "category" "category desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Leads

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "title" "company" "email" "website" "lead_source" "status" "industry" "annual_revenue" "number_of_employees" "owner_id" "is_converted" "converted_date" "converted_account_id" "converted_contact_id" "converted_opportunity_id" "account_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "converted_account" "converted_contact" "converted_opportunity" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "title" "title desc" "company" "company desc" "email" "email desc" "website" "website desc" "lead_source" "lead_source desc" "status" "status desc" "industry" "industry desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "is_converted" "is_converted desc" "converted_date" "converted_date desc" "converted_account_id" "converted_account_id desc" "converted_contact_id" "converted_contact_id desc" "converted_opportunity_id" "converted_opportunity_id desc" "account_id" "account_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Accounts

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "type" "parent_id" "website" "sic" "industry" "currency" "annual_revenue" "number_of_employees" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "parent" "contacts" "opportunities" "leads" "owner" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "type" "type desc" "parent_id" "parent_id desc" "website" "website desc" "sic" "sic desc" "industry" "industry desc" "currency" "currency desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Opportunities

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "account_id" "description" "stage_name" "amount" "currency" "probability" "expected_revenue" "close_date" "type" "next_step" "lead_source" "is_closed" "is_won" "forecast_category" "forecast_category_name" "owner_id" "contact_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "contact" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "account_id" "account_id desc" "description" "description desc" "stage_name" "stage_name desc" "amount" "amount desc" "currency" "currency desc" "probability" "probability desc" "expected_revenue" "expected_revenue desc" "close_date" "close_date desc" "type" "type desc" "next_step" "next_step desc" "lead_source" "lead_source desc" "is_closed" "is_closed desc" "is_won" "is_won desc" "forecast_category" "forecast_category desc" "forecast_category_name" "forecast_category_name desc" "owner_id" "owner_id desc" "contact_id" "contact_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

TopicModels

Topic models are groups of topics based on a filtered group of insights

Get entities from TopicModels

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "archived_at" "title" "description" "visibility" "status"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "topics" "insights"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "archived_at" "archived_at desc" "title" "title desc" "description" "description desc" "visibility" "visibility desc" "status" "status desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entity from TopicModels by key

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "archived_at" "title" "description" "visibility" "status"

Select properties to be returned, see OData Select

expand
Array of strings unique
Items Enum: "topics" "insights"

Expand related entities, see OData Expand

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "archived_at": "2019-08-24T14:15:22Z",
  • "title": "string",
  • "description": "string",
  • "visibility": "string",
  • "status": "string"
}

Get entities from related Topics

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "label" "description" "model_id" "model_index" "key_insight_ids"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "insights" "model" "key_insights" "leads" "accounts" "opportunities"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "label" "label desc" "description" "description desc" "model_id" "model_id desc" "model_index" "model_index desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Insights

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "type" "text" "category"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "topics" "leads" "opportunities" "contacts" "accounts" "owners" "conversations" "participants"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "type" "type desc" "text" "text desc" "category" "category desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Conversations

Conversations hold the base metadata for each recorded call such as the start and end time. Each Conversation can link to the participants and the text fragments.

Get entities from Conversations

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "service_id" "start" "end" "participant_count" "purpose"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "fragments" "participants" "accounts" "contacts" "leads" "opportunities" "owners"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "service_id" "service_id desc" "start" "start desc" "end" "end desc" "participant_count" "participant_count desc" "purpose" "purpose desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entity from Conversations by key

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "service_id" "start" "end" "participant_count" "purpose"

Select properties to be returned, see OData Select

expand
Array of strings unique
Items Enum: "fragments" "participants" "accounts" "contacts" "leads" "opportunities" "owners"

Expand related entities, see OData Expand

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "service_id": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "participant_count": -9223372036854776000,
  • "purpose": "string"
}

Get entities from related Fragments

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "conversation_id" "participant_id" "start" "end" "text"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "conversation" "participant"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "conversation_id" "conversation_id desc" "participant_id" "participant_id desc" "start" "start desc" "end" "end desc" "text" "text desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Participants

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "conversation_id" "service_id" "timestamp" "email" "name" "role"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Value: "fragments"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "conversation_id" "conversation_id desc" "service_id" "service_id desc" "timestamp" "timestamp desc" "email" "email desc" "name" "name desc" "role" "role desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Accounts

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "type" "parent_id" "website" "sic" "industry" "currency" "annual_revenue" "number_of_employees" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "parent" "contacts" "opportunities" "leads" "owner" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "type" "type desc" "parent_id" "parent_id desc" "website" "website desc" "sic" "sic desc" "industry" "industry desc" "currency" "currency desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Contacts

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "account_id" "department" "lead_source" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "opportunities" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "email" "email desc" "title" "title desc" "account_id" "account_id desc" "department" "department desc" "lead_source" "lead_source desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Leads

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "title" "company" "email" "website" "lead_source" "status" "industry" "annual_revenue" "number_of_employees" "owner_id" "is_converted" "converted_date" "converted_account_id" "converted_contact_id" "converted_opportunity_id" "account_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "converted_account" "converted_contact" "converted_opportunity" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "title" "title desc" "company" "company desc" "email" "email desc" "website" "website desc" "lead_source" "lead_source desc" "status" "status desc" "industry" "industry desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "is_converted" "is_converted desc" "converted_date" "converted_date desc" "converted_account_id" "converted_account_id desc" "converted_contact_id" "converted_contact_id desc" "converted_opportunity_id" "converted_opportunity_id desc" "account_id" "account_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Opportunities

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "account_id" "description" "stage_name" "amount" "currency" "probability" "expected_revenue" "close_date" "type" "next_step" "lead_source" "is_closed" "is_won" "forecast_category" "forecast_category_name" "owner_id" "contact_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "contact" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "account_id" "account_id desc" "description" "description desc" "stage_name" "stage_name desc" "amount" "amount desc" "currency" "currency desc" "probability" "probability desc" "expected_revenue" "expected_revenue desc" "close_date" "close_date desc" "type" "type desc" "next_step" "next_step desc" "lead_source" "lead_source desc" "is_closed" "is_closed desc" "is_won" "is_won desc" "forecast_category" "forecast_category desc" "forecast_category_name" "forecast_category_name desc" "owner_id" "owner_id desc" "contact_id" "contact_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Owners

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "opportunities" "accounts" "contacts" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "email" "email desc" "title" "title desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Fragments

Fragments are the individual text snippets of conversations.

Get entities from Fragments

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "conversation_id" "participant_id" "start" "end" "text"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "conversation" "participant"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "conversation_id" "conversation_id desc" "participant_id" "participant_id desc" "start" "start desc" "end" "end desc" "text" "text desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entity from Fragments by key

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "conversation_id" "participant_id" "start" "end" "text"

Select properties to be returned, see OData Select

expand
Array of strings unique
Items Enum: "conversation" "participant"

Expand related entities, see OData Expand

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",
  • "participant_id": "78084e63-1c1c-45af-adf1-2af96784867b",
  • "start": 0.1,
  • "end": 0.1,
  • "text": "string"
}

Get entities from related Conversations

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "service_id" "start" "end" "participant_count" "purpose"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "fragments" "participants" "accounts" "contacts" "leads" "opportunities" "owners"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "service_id" "service_id desc" "start" "start desc" "end" "end desc" "participant_count" "participant_count desc" "purpose" "purpose desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Participants

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "conversation_id" "service_id" "timestamp" "email" "name" "role"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Value: "fragments"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "conversation_id" "conversation_id desc" "service_id" "service_id desc" "timestamp" "timestamp desc" "email" "email desc" "name" "name desc" "role" "role desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Participants

Participants hold the metadata about each person that joined the conversation.

Get entities from Participants

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "conversation_id" "service_id" "timestamp" "email" "name" "role"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Value: "fragments"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "conversation_id" "conversation_id desc" "service_id" "service_id desc" "timestamp" "timestamp desc" "email" "email desc" "name" "name desc" "role" "role desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entity from Participants by key

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "conversation_id" "service_id" "timestamp" "email" "name" "role"

Select properties to be returned, see OData Select

expand
Array of strings unique
Items Value: "fragments"

Expand related entities, see OData Expand

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",
  • "service_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "name": "string",
  • "role": "string"
}

Get entities from related Fragments

path Parameters
id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "conversation_id" "participant_id" "start" "end" "text"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "conversation" "participant"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "conversation_id" "conversation_id desc" "participant_id" "participant_id desc" "start" "start desc" "end" "end desc" "text" "text desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Accounts

This entity set mirrors the Account object from the CRM the service is connected to.

Get entities from Accounts

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "type" "parent_id" "website" "sic" "industry" "currency" "annual_revenue" "number_of_employees" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "parent" "contacts" "opportunities" "leads" "owner" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "type" "type desc" "parent_id" "parent_id desc" "website" "website desc" "sic" "sic desc" "industry" "industry desc" "currency" "currency desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entity from Accounts by key

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "type" "parent_id" "website" "sic" "industry" "currency" "annual_revenue" "number_of_employees" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

expand
Array of strings unique
Items Enum: "parent" "contacts" "opportunities" "leads" "owner" "insights" "conversations"

Expand related entities, see OData Expand

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "parent_id": "string",
  • "website": "string",
  • "sic": "string",
  • "industry": "string",
  • "currency": "string",
  • "annual_revenue": 0.1,
  • "number_of_employees": -9223372036854776000,
  • "owner_id": "string",
  • "region": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

Get entities from related Accounts

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "type" "parent_id" "website" "sic" "industry" "currency" "annual_revenue" "number_of_employees" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "parent" "contacts" "opportunities" "leads" "owner" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "type" "type desc" "parent_id" "parent_id desc" "website" "website desc" "sic" "sic desc" "industry" "industry desc" "currency" "currency desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Contacts

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "account_id" "department" "lead_source" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "opportunities" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "email" "email desc" "title" "title desc" "account_id" "account_id desc" "department" "department desc" "lead_source" "lead_source desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Opportunities

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "account_id" "description" "stage_name" "amount" "currency" "probability" "expected_revenue" "close_date" "type" "next_step" "lead_source" "is_closed" "is_won" "forecast_category" "forecast_category_name" "owner_id" "contact_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "contact" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "account_id" "account_id desc" "description" "description desc" "stage_name" "stage_name desc" "amount" "amount desc" "currency" "currency desc" "probability" "probability desc" "expected_revenue" "expected_revenue desc" "close_date" "close_date desc" "type" "type desc" "next_step" "next_step desc" "lead_source" "lead_source desc" "is_closed" "is_closed desc" "is_won" "is_won desc" "forecast_category" "forecast_category desc" "forecast_category_name" "forecast_category_name desc" "owner_id" "owner_id desc" "contact_id" "contact_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Leads

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "title" "company" "email" "website" "lead_source" "status" "industry" "annual_revenue" "number_of_employees" "owner_id" "is_converted" "converted_date" "converted_account_id" "converted_contact_id" "converted_opportunity_id" "account_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "converted_account" "converted_contact" "converted_opportunity" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "title" "title desc" "company" "company desc" "email" "email desc" "website" "website desc" "lead_source" "lead_source desc" "status" "status desc" "industry" "industry desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "is_converted" "is_converted desc" "converted_date" "converted_date desc" "converted_account_id" "converted_account_id desc" "converted_contact_id" "converted_contact_id desc" "converted_opportunity_id" "converted_opportunity_id desc" "account_id" "account_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Owners

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "opportunities" "accounts" "contacts" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "email" "email desc" "title" "title desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Insights

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "type" "text" "category"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "topics" "leads" "opportunities" "contacts" "accounts" "owners" "conversations" "participants"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "type" "type desc" "text" "text desc" "category" "category desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Conversations

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "service_id" "start" "end" "participant_count" "purpose"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "fragments" "participants" "accounts" "contacts" "leads" "opportunities" "owners"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "service_id" "service_id desc" "start" "start desc" "end" "end desc" "participant_count" "participant_count desc" "purpose" "purpose desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Contacts

This entity set mirrors the Contact object from the CRM the service is connected to.

Get entities from Contacts

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "account_id" "department" "lead_source" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "opportunities" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "email" "email desc" "title" "title desc" "account_id" "account_id desc" "department" "department desc" "lead_source" "lead_source desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entity from Contacts by key

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "account_id" "department" "lead_source" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

expand
Array of strings unique
Items Enum: "account" "owner" "opportunities" "lead" "insights" "conversations"

Expand related entities, see OData Expand

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "title": "string",
  • "account_id": "string",
  • "department": "string",
  • "lead_source": "string",
  • "owner_id": "string",
  • "region": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

Get entities from related Accounts

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "type" "parent_id" "website" "sic" "industry" "currency" "annual_revenue" "number_of_employees" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "parent" "contacts" "opportunities" "leads" "owner" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "type" "type desc" "parent_id" "parent_id desc" "website" "website desc" "sic" "sic desc" "industry" "industry desc" "currency" "currency desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Owners

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "opportunities" "accounts" "contacts" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "email" "email desc" "title" "title desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Opportunities

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "account_id" "description" "stage_name" "amount" "currency" "probability" "expected_revenue" "close_date" "type" "next_step" "lead_source" "is_closed" "is_won" "forecast_category" "forecast_category_name" "owner_id" "contact_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "contact" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "account_id" "account_id desc" "description" "description desc" "stage_name" "stage_name desc" "amount" "amount desc" "currency" "currency desc" "probability" "probability desc" "expected_revenue" "expected_revenue desc" "close_date" "close_date desc" "type" "type desc" "next_step" "next_step desc" "lead_source" "lead_source desc" "is_closed" "is_closed desc" "is_won" "is_won desc" "forecast_category" "forecast_category desc" "forecast_category_name" "forecast_category_name desc" "owner_id" "owner_id desc" "contact_id" "contact_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Leads

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "title" "company" "email" "website" "lead_source" "status" "industry" "annual_revenue" "number_of_employees" "owner_id" "is_converted" "converted_date" "converted_account_id" "converted_contact_id" "converted_opportunity_id" "account_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "converted_account" "converted_contact" "converted_opportunity" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "title" "title desc" "company" "company desc" "email" "email desc" "website" "website desc" "lead_source" "lead_source desc" "status" "status desc" "industry" "industry desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "is_converted" "is_converted desc" "converted_date" "converted_date desc" "converted_account_id" "converted_account_id desc" "converted_contact_id" "converted_contact_id desc" "converted_opportunity_id" "converted_opportunity_id desc" "account_id" "account_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Insights

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "type" "text" "category"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "topics" "leads" "opportunities" "contacts" "accounts" "owners" "conversations" "participants"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "type" "type desc" "text" "text desc" "category" "category desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Conversations

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "service_id" "start" "end" "participant_count" "purpose"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "fragments" "participants" "accounts" "contacts" "leads" "opportunities" "owners"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "service_id" "service_id desc" "start" "start desc" "end" "end desc" "participant_count" "participant_count desc" "purpose" "purpose desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Owners

This entity set mirrors the Owner or User object from the CRM the service is connected to.

Get entities from Owners

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "opportunities" "accounts" "contacts" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "email" "email desc" "title" "title desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entity from Owners by key

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "created" "updated"

Select properties to be returned, see OData Select

expand
Array of strings unique
Items Enum: "opportunities" "accounts" "contacts" "insights" "conversations"

Expand related entities, see OData Expand

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "title": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

Get entities from related Opportunities

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "account_id" "description" "stage_name" "amount" "currency" "probability" "expected_revenue" "close_date" "type" "next_step" "lead_source" "is_closed" "is_won" "forecast_category" "forecast_category_name" "owner_id" "contact_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "contact" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "account_id" "account_id desc" "description" "description desc" "stage_name" "stage_name desc" "amount" "amount desc" "currency" "currency desc" "probability" "probability desc" "expected_revenue" "expected_revenue desc" "close_date" "close_date desc" "type" "type desc" "next_step" "next_step desc" "lead_source" "lead_source desc" "is_closed" "is_closed desc" "is_won" "is_won desc" "forecast_category" "forecast_category desc" "forecast_category_name" "forecast_category_name desc" "owner_id" "owner_id desc" "contact_id" "contact_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Accounts

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "type" "parent_id" "website" "sic" "industry" "currency" "annual_revenue" "number_of_employees" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "parent" "contacts" "opportunities" "leads" "owner" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "type" "type desc" "parent_id" "parent_id desc" "website" "website desc" "sic" "sic desc" "industry" "industry desc" "currency" "currency desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Contacts

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "account_id" "department" "lead_source" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "opportunities" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "email" "email desc" "title" "title desc" "account_id" "account_id desc" "department" "department desc" "lead_source" "lead_source desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Insights

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "type" "text" "category"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "topics" "leads" "opportunities" "contacts" "accounts" "owners" "conversations" "participants"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "type" "type desc" "text" "text desc" "category" "category desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Conversations

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "service_id" "start" "end" "participant_count" "purpose"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "fragments" "participants" "accounts" "contacts" "leads" "opportunities" "owners"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "service_id" "service_id desc" "start" "start desc" "end" "end desc" "participant_count" "participant_count desc" "purpose" "purpose desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Opportunities

This entity set mirrors the Opportunity or Deal object from the CRM the service is connected to.

Get entities from Opportunities

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "account_id" "description" "stage_name" "amount" "currency" "probability" "expected_revenue" "close_date" "type" "next_step" "lead_source" "is_closed" "is_won" "forecast_category" "forecast_category_name" "owner_id" "contact_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "contact" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "account_id" "account_id desc" "description" "description desc" "stage_name" "stage_name desc" "amount" "amount desc" "currency" "currency desc" "probability" "probability desc" "expected_revenue" "expected_revenue desc" "close_date" "close_date desc" "type" "type desc" "next_step" "next_step desc" "lead_source" "lead_source desc" "is_closed" "is_closed desc" "is_won" "is_won desc" "forecast_category" "forecast_category desc" "forecast_category_name" "forecast_category_name desc" "owner_id" "owner_id desc" "contact_id" "contact_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entity from Opportunities by key

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "account_id" "description" "stage_name" "amount" "currency" "probability" "expected_revenue" "close_date" "type" "next_step" "lead_source" "is_closed" "is_won" "forecast_category" "forecast_category_name" "owner_id" "contact_id" "region" "created" "updated"

Select properties to be returned, see OData Select

expand
Array of strings unique
Items Enum: "account" "owner" "contact" "lead" "insights" "conversations"

Expand related entities, see OData Expand

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "account_id": "string",
  • "description": "string",
  • "stage_name": "string",
  • "amount": 0.1,
  • "currency": "string",
  • "probability": -9223372036854776000,
  • "expected_revenue": 0.1,
  • "close_date": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "next_step": "string",
  • "lead_source": "string",
  • "is_closed": true,
  • "is_won": true,
  • "forecast_category": "string",
  • "forecast_category_name": "string",
  • "owner_id": "string",
  • "contact_id": "string",
  • "region": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

Get entities from related Accounts

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "type" "parent_id" "website" "sic" "industry" "currency" "annual_revenue" "number_of_employees" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "parent" "contacts" "opportunities" "leads" "owner" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "type" "type desc" "parent_id" "parent_id desc" "website" "website desc" "sic" "sic desc" "industry" "industry desc" "currency" "currency desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Owners

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "opportunities" "accounts" "contacts" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "email" "email desc" "title" "title desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Contacts

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "account_id" "department" "lead_source" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "opportunities" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "email" "email desc" "title" "title desc" "account_id" "account_id desc" "department" "department desc" "lead_source" "lead_source desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Leads

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "title" "company" "email" "website" "lead_source" "status" "industry" "annual_revenue" "number_of_employees" "owner_id" "is_converted" "converted_date" "converted_account_id" "converted_contact_id" "converted_opportunity_id" "account_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "converted_account" "converted_contact" "converted_opportunity" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "title" "title desc" "company" "company desc" "email" "email desc" "website" "website desc" "lead_source" "lead_source desc" "status" "status desc" "industry" "industry desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "is_converted" "is_converted desc" "converted_date" "converted_date desc" "converted_account_id" "converted_account_id desc" "converted_contact_id" "converted_contact_id desc" "converted_opportunity_id" "converted_opportunity_id desc" "account_id" "account_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Insights

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "type" "text" "category"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "topics" "leads" "opportunities" "contacts" "accounts" "owners" "conversations" "participants"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "type" "type desc" "text" "text desc" "category" "category desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Conversations

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "service_id" "start" "end" "participant_count" "purpose"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "fragments" "participants" "accounts" "contacts" "leads" "opportunities" "owners"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "service_id" "service_id desc" "start" "start desc" "end" "end desc" "participant_count" "participant_count desc" "purpose" "purpose desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Leads

This entity set mirrors the Lead object from the CRM the service is connected to. It may be empty if your CRM does not use separate lead records.

Get entities from Leads

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "title" "company" "email" "website" "lead_source" "status" "industry" "annual_revenue" "number_of_employees" "owner_id" "is_converted" "converted_date" "converted_account_id" "converted_contact_id" "converted_opportunity_id" "account_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "converted_account" "converted_contact" "converted_opportunity" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "title" "title desc" "company" "company desc" "email" "email desc" "website" "website desc" "lead_source" "lead_source desc" "status" "status desc" "industry" "industry desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "is_converted" "is_converted desc" "converted_date" "converted_date desc" "converted_account_id" "converted_account_id desc" "converted_contact_id" "converted_contact_id desc" "converted_opportunity_id" "converted_opportunity_id desc" "account_id" "account_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entity from Leads by key

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "title" "company" "email" "website" "lead_source" "status" "industry" "annual_revenue" "number_of_employees" "owner_id" "is_converted" "converted_date" "converted_account_id" "converted_contact_id" "converted_opportunity_id" "account_id" "region" "created" "updated"

Select properties to be returned, see OData Select

expand
Array of strings unique
Items Enum: "account" "converted_account" "converted_contact" "converted_opportunity" "insights" "conversations"

Expand related entities, see OData Expand

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "title": "string",
  • "company": "string",
  • "email": "string",
  • "website": "string",
  • "lead_source": "string",
  • "status": "string",
  • "industry": "string",
  • "annual_revenue": 0.1,
  • "number_of_employees": -9223372036854776000,
  • "owner_id": "string",
  • "is_converted": true,
  • "converted_date": "2019-08-24T14:15:22Z",
  • "converted_account_id": "string",
  • "converted_contact_id": "string",
  • "converted_opportunity_id": "string",
  • "account_id": "string",
  • "region": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

Get entities from related Accounts

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "type" "parent_id" "website" "sic" "industry" "currency" "annual_revenue" "number_of_employees" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "parent" "contacts" "opportunities" "leads" "owner" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "type" "type desc" "parent_id" "parent_id desc" "website" "website desc" "sic" "sic desc" "industry" "industry desc" "currency" "currency desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Accounts

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "type" "parent_id" "website" "sic" "industry" "currency" "annual_revenue" "number_of_employees" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "parent" "contacts" "opportunities" "leads" "owner" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "type" "type desc" "parent_id" "parent_id desc" "website" "website desc" "sic" "sic desc" "industry" "industry desc" "currency" "currency desc" "annual_revenue" "annual_revenue desc" "number_of_employees" "number_of_employees desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Contacts

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "first_name" "last_name" "email" "title" "account_id" "department" "lead_source" "owner_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "opportunities" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "first_name" "first_name desc" "last_name" "last_name desc" "email" "email desc" "title" "title desc" "account_id" "account_id desc" "department" "department desc" "lead_source" "lead_source desc" "owner_id" "owner_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Opportunities

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "name" "account_id" "description" "stage_name" "amount" "currency" "probability" "expected_revenue" "close_date" "type" "next_step" "lead_source" "is_closed" "is_won" "forecast_category" "forecast_category_name" "owner_id" "contact_id" "region" "created" "updated"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "account" "owner" "contact" "lead" "insights" "conversations"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "name" "name desc" "account_id" "account_id desc" "description" "description desc" "stage_name" "stage_name desc" "amount" "amount desc" "currency" "currency desc" "probability" "probability desc" "expected_revenue" "expected_revenue desc" "close_date" "close_date desc" "type" "type desc" "next_step" "next_step desc" "lead_source" "lead_source desc" "is_closed" "is_closed desc" "is_won" "is_won desc" "forecast_category" "forecast_category desc" "forecast_category_name" "forecast_category_name desc" "owner_id" "owner_id desc" "contact_id" "contact_id desc" "region" "region desc" "created" "created desc" "updated" "updated desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Insights

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "created_at" "type" "text" "category"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "topics" "leads" "opportunities" "contacts" "accounts" "owners" "conversations" "participants"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "created_at" "created_at desc" "type" "type desc" "text" "text desc" "category" "category desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Get entities from related Conversations

path Parameters
id
required
string

Key: id

query Parameters
select
Array of strings unique
Items Enum: "*" "id" "service_id" "start" "end" "participant_count" "purpose"

Select properties to be returned, see OData Select

count
boolean

Include count of items, see OData Count

expand
Array of strings unique
Items Enum: "fragments" "participants" "accounts" "contacts" "leads" "opportunities" "owners"

Expand related entities, see OData Expand

filter
string

Filter items by property values, see OData Filtering

search
string

Search items by search phrases, see OData Searching

top
integer >= 0

Show only the first n items, see OData Paging – Top

skip
integer >= 0

Skip the first n items, see OData Paging - Skip

orderby
Array of strings unique
Items Enum: "id" "id desc" "service_id" "service_id desc" "start" "start desc" "end" "end desc" "participant_count" "participant_count desc" "purpose" "purpose desc"

Order items by property values, see OData Sorting

Responses

Response samples

Content type
application/json
{
  • "value": [
    ],
  • "@count": 0
}

Batch requests

Send a group of requests

Group multiple requests into a single request payload, see Batch requests

Request Body schema:
required

Batch request

Array of objects

Responses

Request samples

Content type
{
  • "requests": [
    ]
}

Response samples

Content type
{
  • "responses": [
    ]
}