InterAction+™ Cloud API
Welcome to InterAction+™ Cloud API
API Endpoints
# Production - US:
https://tm-prod-us.apps.interaction.com/public-api/graphql
# Production - EU:
https://tm-prod-eu.apps.interaction.com/public-api/graphql
# Production - AU:
https://tm-prod-au.apps.interaction.com/public-api/graphql
Version
1.x
Purpose
The InterAction+™ Cloud API will provide third parties, professional services, and customer projects access to InterAction+™ data.
API User
Authentication and Authorization for the API is currently targeting system to system scenarios. As a result, we require firms to pick a single user that will act as the consumer of the API.
Queries
company
Description
Retrieves a company contact.
Response
Returns a Company
Arguments
| Name | Description |
|---|---|
id - ID!
|
The ID of the company contact to retrieve. |
Example
Query
query company($id: ID!) {
company(id: $id) {
id
displayName
contactEntity
visibility
notes {
allNotes {
...NoteResultsFragment
}
}
name
alias
relationshipScore {
strength
value
maxValue
description
}
isPendingFirmContact
addresses {
id
type
usage
label
street
city
administrativeDivision
additional
country
postalCode
isGlobal
isMailingAddress
owningContactId
}
tags
contactTypes {
id
name
}
emailAddresses {
id
type
usage
address
label
owningContactId
isGlobal
}
phoneNumbers {
id
addressId
number
label
type
usage
owningContactId
isGlobal
}
additionalFieldValues {
totalModels
models {
...AdditionalFieldValueFragment
}
}
contactAdditionalFieldValues {
totalModels
models {
...ContactAdditionalFieldValueFragment
}
}
}
}
Variables
{
"id": "00000006-0002-0000-0000-000000000000"
}
Response
{
"data": {
"company": {
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "xyz789",
"contactEntity": "Any",
"visibility": "unknown",
"notes": Notes,
"name": "xyz789",
"alias": "abc123",
"relationshipScore": Score,
"isPendingFirmContact": true,
"addresses": [Address],
"tags": ["xyz789"],
"contactTypes": [ContactFolderContactType],
"emailAddresses": [EmailAddress],
"phoneNumbers": [PhoneNumber],
"additionalFieldValues": AdditionalFieldValueResults,
"contactAdditionalFieldValues": ContactAdditionalFieldValueResults
}
}
}
contact
Description
Retrieves a contact.
Example
Query
query contact($id: ID!) {
contact(id: $id) {
id
displayName
contactEntity
visibility
relationshipScore {
strength
value
maxValue
description
}
tags
contactTypes {
id
name
}
addresses {
id
type
usage
label
street
city
administrativeDivision
additional
country
postalCode
isGlobal
isMailingAddress
owningContactId
}
emailAddresses {
id
type
usage
address
label
owningContactId
isGlobal
}
phoneNumbers {
id
addressId
number
label
type
usage
owningContactId
isGlobal
}
notes {
allNotes {
...NoteResultsFragment
}
}
additionalFieldValues {
totalModels
models {
...AdditionalFieldValueFragment
}
}
contactAdditionalFieldValues {
totalModels
models {
...ContactAdditionalFieldValueFragment
}
}
}
}
Variables
{
"id": "00000006-0002-0000-0000-000000000000"
}
Response
{
"data": {
"contact": {
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "abc123",
"contactEntity": "Any",
"visibility": "unknown",
"relationshipScore": Score,
"tags": ["xyz789"],
"contactTypes": [ContactFolderContactType],
"addresses": [Address],
"emailAddresses": [EmailAddress],
"phoneNumbers": [PhoneNumber],
"notes": Notes,
"additionalFieldValues": AdditionalFieldValueResults,
"contactAdditionalFieldValues": ContactAdditionalFieldValueResults
}
}
}
contactTypes
Description
Retrieves contact types based on specified criteria.
Response
Returns a ContactTypeResults
Arguments
| Name | Description |
|---|---|
input - GetContactTypeInput
|
The filter criteria for the contact types. |
skip - Int
|
The starting index for pagination. Default = 0 |
limit - Int
|
The maximum number of items to retrieve. Default = 100 |
Example
Query
query contactTypes(
$input: GetContactTypeInput,
$skip: Int,
$limit: Int
) {
contactTypes(
input: $input,
skip: $skip,
limit: $limit
) {
totalModels
models {
id
name
pluralName
folderId
folderType
allowedContactEntity
}
}
}
Variables
{"input": GetContactTypeInput, "skip": 0, "limit": 100}
Response
{
"data": {
"contactTypes": {
"totalModels": 987,
"models": [ContactType]
}
}
}
countries
Description
Retrieve a list of countries.
Response
Returns a CountryResults
Arguments
| Name | Description |
|---|---|
filter - CountryFilter
|
Specifies the filter settings for the countries. |
Example
Query
query countries($filter: CountryFilter) {
countries(filter: $filter) {
totalModels
models {
id
name
isoCode
statusIndicator
administrativeDivisions {
...AdministrativeDivisionsFragment
}
}
}
}
Variables
{"filter": CountryFilter}
Response
{
"data": {
"countries": {"totalModels": 123, "models": [Country]}
}
}
country
Description
Retrieves a country.
Example
Query
query country($id: ID!) {
country(id: $id) {
id
name
isoCode
statusIndicator
administrativeDivisions {
states {
...StateFragment
}
useStates
stateLabel
postalCodeLabel
}
}
}
Variables
{
"id": "00000006-0002-0000-0000-000000000000"
}
Response
{
"data": {
"country": {
"id": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"isoCode": "abc123",
"statusIndicator": 123,
"administrativeDivisions": AdministrativeDivisions
}
}
}
currencies
Description
Retrieves a list of ISO currency codes.
Response
Returns [String]
Example
Query
query currencies {
currencies
}
Response
{"data": {"currencies": ["abc123"]}}
customFieldControls
Description
Retrieves the list of custom field controls.
Response
Returns [CustomFieldControl]
Example
Query
query customFieldControls {
customFieldControls {
controlType
dataType
controlDisplayName
}
}
Response
{
"data": {
"customFieldControls": [
{
"controlType": "TextArea",
"dataType": "None",
"controlDisplayName": "abc123"
}
]
}
}
customForm
Description
Retrieves a custom form.
Response
Returns a CustomForm
Arguments
| Name | Description |
|---|---|
id - ID!
|
The ID of the custom form to retrieve. |
Example
Query
query customForm($id: ID!) {
customForm(id: $id) {
id
name
description
entityType
isActive
canRemove
customFields {
skip
limit
sort {
...SortFragment
}
totalModels
models {
...CustomFieldFragment
}
}
customFieldValues {
customField {
...CustomFieldFragment
}
values {
...CustomFieldDataFragment
}
}
}
}
Variables
{
"id": "00000006-0002-0000-0000-000000000000"
}
Response
{
"data": {
"customForm": {
"id": "00000006-0002-0000-0000-000000000000",
"name": "xyz789",
"description": "xyz789",
"entityType": "opportunity",
"isActive": true,
"canRemove": true,
"customFields": CustomFieldResults,
"customFieldValues": [CustomFieldValue]
}
}
}
customForms
Description
Retrieves a list of custom forms.
Response
Returns a CustomFormResults
Arguments
| Name | Description |
|---|---|
skip - Int
|
The starting index for pagination. Default = 0 |
limit - Int
|
The maximum number of items to retrieve. Default = 100 |
sorts - [CustomFormSort]
|
The sorting options for the custom forms. |
filter - CustomFormFilterInput
|
The filter criteria for the custom forms. |
Example
Query
query customForms(
$skip: Int,
$limit: Int,
$sorts: [CustomFormSort],
$filter: CustomFormFilterInput
) {
customForms(
skip: $skip,
limit: $limit,
sorts: $sorts,
filter: $filter
) {
skip
limit
sort {
field
direction
}
totalModels
models {
id
name
description
entityType
isActive
canRemove
customFields {
...CustomFieldResultsFragment
}
customFieldValues {
...CustomFieldValueFragment
}
}
}
}
Variables
{
"skip": 0,
"limit": 100,
"sorts": [CustomFormSort],
"filter": CustomFormFilterInput
}
Response
{
"data": {
"customForms": {
"skip": 123,
"limit": 123,
"sort": Sort,
"totalModels": 123,
"models": [CustomForm]
}
}
}
firm
Description
Retrieve the firm settings.
Response
Returns a Firm
Example
Query
query firm {
firm {
settings {
minimumRequiredFields
titles
suffixes
languageSettings {
...LanguageSettingsFragment
}
genderSettings {
...GenderSettingsFragment
}
defaultNewActivityTypeId
}
}
}
Response
{"data": {"firm": {"settings": FirmSettings}}}
firmContactEventViews
Description
Retrieves firm contact events based on specified criteria. This includes events for both firm contacts and list-specific contacts. For deleted contacts, no events are returned unless the filter includes the ContactDeleted event type to determine whether the contact has been deleted. Event data is derived from audit logs, so its accuracy depends on the customer's retention policies.
Response
Returns a FirmContactEventViewResults
Arguments
| Name | Description |
|---|---|
skip - Int
|
The starting index for pagination. Default = 0 |
limit - Int
|
The maximum number of items to retrieve. Default = 100 |
sort - [FirmContactEventViewSortInput!]
|
The sorting options for the firm contact events. |
filter - FirmContactEventViewFilterInput
|
Specifies the filter settings for the firm contact events. |
Example
Query
query firmContactEventViews(
$skip: Int,
$limit: Int,
$sort: [FirmContactEventViewSortInput!],
$filter: FirmContactEventViewFilterInput
) {
firmContactEventViews(
skip: $skip,
limit: $limit,
sort: $sort,
filter: $filter
) {
totalModels
models {
eventType
eventDate
contactId
contact {
...ContactFragment
}
}
}
}
Variables
{
"skip": 0,
"limit": 100,
"sort": [FirmContactEventViewSortInput],
"filter": FirmContactEventViewFilterInput
}
Response
{
"data": {
"firmContactEventViews": {
"totalModels": 987,
"models": [FirmContactEventView]
}
}
}
industries
Description
Retrieves a list of industries.
Response
Returns an IndustryResults
Example
Query
query industries {
industries {
totalModels
models {
id
name
}
}
}
Response
{
"data": {
"industries": {
"totalModels": 123,
"models": [Industry]
}
}
}
opportunities
Description
Retrieves a list of opportunities.
Response
Returns an OpportunityResults
Arguments
| Name | Description |
|---|---|
skip - Int
|
The starting index for pagination of opportunities. Default = 0 |
limit - Int
|
The maximum number of opportunities to retrieve. Default = 100 |
sort - [OpportunitySortInput!]
|
The sorting options for the opportunities. |
filter - OpportunityFilterInput
|
The filter criteria for the opportunities. |
Example
Query
query opportunities(
$skip: Int,
$limit: Int,
$sort: [OpportunitySortInput!],
$filter: OpportunityFilterInput
) {
opportunities(
skip: $skip,
limit: $limit,
sort: $sort,
filter: $filter
) {
totalModels
models {
id
title
description
creatorId
targetCompany {
...CompanyFragment
}
opportunityType {
...OpportunityTypeFragment
}
actualOutcome {
...OpportunityOutcomeFragment
}
actualOutcomeReason {
...OpportunityOutcomeReasonFragment
}
associatedOutcomeReasons {
...OpportunityOutcomeReasonCollectionFragment
}
originationSource {
...OpportunityOriginationSourceFragment
}
originationSourceContact {
...PersonFragment
}
originationSourceCompany {
...CompanyFragment
}
associatedPrincipals {
...OpportunityLeadFragment
}
associatedContacts {
...OpportunityTargetCompanyContactFragment
}
stageInstances {
...OpportunityStageInstanceFragment
}
estimatedCloseDate
dateOpened
actualCloseDate
associatedMatter
associatedInitiative {
...InitiativeFragment
}
activities {
...InitiativeActivityResultsFragment
}
practiceGroups {
...PracticeGroupFragment
}
industries {
...IndustryFragment
}
workTypeId
status
isConfidential
shouldBeHidden
isCurrentUserInvolved
lead {
...PersonFragment
}
tags {
...OpportunityTagFragment
}
currentStage {
...OpportunityStageInstanceFragment
}
associatedInitiatives {
...InitiativeFragment
}
}
}
}
Variables
{
"skip": 0,
"limit": 100,
"sort": [OpportunitySortInput],
"filter": OpportunityFilterInput
}
Response
{
"data": {
"opportunities": {
"totalModels": 987,
"models": [Opportunity]
}
}
}
opportunity
Description
Retrieves an opportunity.
Response
Returns an Opportunity
Arguments
| Name | Description |
|---|---|
id - ID!
|
The ID of the opportunity to retrieve. |
Example
Query
query opportunity($id: ID!) {
opportunity(id: $id) {
id
title
description
creatorId
targetCompany {
id
displayName
contactEntity
visibility
notes {
...NotesFragment
}
name
alias
relationshipScore {
...ScoreFragment
}
isPendingFirmContact
addresses {
...AddressFragment
}
tags
contactTypes {
...ContactFolderContactTypeFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
opportunityType {
id
name
description
isActive
}
actualOutcome {
id
name
description
reasons {
...OpportunityOutcomeReasonFragment
}
}
actualOutcomeReason {
id
name
description
outcomeId
isActive
}
associatedOutcomeReasons {
id
name
opportunityId
outcomeId
outcomeReason {
...OpportunityOutcomeReasonFragment
}
outcome {
...OpportunityOutcomeFragment
}
}
originationSource {
id
name
description
isActive
}
originationSourceContact {
id
displayName
contactEntity
notes {
...NotesFragment
}
visibility
relationshipScore {
...ScoreFragment
}
isEmployee
isPendingFirmContact
title
firstName
middleName
lastName
fullName
suffix
goesBy
currentJobTitle
currentEmployer {
...CompanyFragment
}
assistantName
contactTypes {
...ContactFolderContactTypeFragment
}
tags
addresses {
...AddressFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
originationSourceCompany {
id
displayName
contactEntity
visibility
notes {
...NotesFragment
}
name
alias
relationshipScore {
...ScoreFragment
}
isPendingFirmContact
addresses {
...AddressFragment
}
tags
contactTypes {
...ContactFolderContactTypeFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
associatedPrincipals {
opportunityId
accountName
isGroup
isPrimary
fullName
leadId
}
associatedContacts {
opportunityId
contactId
person {
...PersonFragment
}
isPrimary
}
stageInstances {
id
opportunityId
stageName
stageOrder
timeEntered
timeSpent
}
estimatedCloseDate
dateOpened
actualCloseDate
associatedMatter
associatedInitiative {
id
name
description
startDate
endDate
closedDate
status
creatorId
createdBy
progress
isDeleted
objective {
...ObjectiveFragment
}
companies {
...BusinessPlanningInitiativeCompanyFragment
}
locations {
...BusinessPlanningLocationFragment
}
involvedUsers {
...BusinessPlanningPersonFragment
}
companyEmployeeRelationships {
...BusinessPlanningConnectionResultsFragment
}
companyEmployees {
...CompanyEmployeeResultsFragment
}
tags {
...BusinessPlanningTagFragment
}
types {
...BusinessPlanningTypesFragment
}
activityCounts {
...InitiativeActivityCountResultsFragment
}
activities {
...InitiativeActivityResultsFragment
}
measurementOfSuccess {
...BusinessPlanningMeasurementOfSuccessFragment
}
}
activities {
skip
limit
sort {
...SortFragment
}
models {
...BusinessPlanningActivityFragment
}
totalModels
}
practiceGroups {
id
name
}
industries {
id
name
}
workTypeId
status
isConfidential
shouldBeHidden
isCurrentUserInvolved
lead {
id
displayName
contactEntity
notes {
...NotesFragment
}
visibility
relationshipScore {
...ScoreFragment
}
isEmployee
isPendingFirmContact
title
firstName
middleName
lastName
fullName
suffix
goesBy
currentJobTitle
currentEmployer {
...CompanyFragment
}
assistantName
contactTypes {
...ContactFolderContactTypeFragment
}
tags
addresses {
...AddressFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
tags {
type
displayName
}
currentStage {
id
opportunityId
stageName
stageOrder
timeEntered
timeSpent
}
associatedInitiatives {
id
name
description
startDate
endDate
closedDate
status
creatorId
createdBy
progress
isDeleted
objective {
...ObjectiveFragment
}
companies {
...BusinessPlanningInitiativeCompanyFragment
}
locations {
...BusinessPlanningLocationFragment
}
involvedUsers {
...BusinessPlanningPersonFragment
}
companyEmployeeRelationships {
...BusinessPlanningConnectionResultsFragment
}
companyEmployees {
...CompanyEmployeeResultsFragment
}
tags {
...BusinessPlanningTagFragment
}
types {
...BusinessPlanningTypesFragment
}
activityCounts {
...InitiativeActivityCountResultsFragment
}
activities {
...InitiativeActivityResultsFragment
}
measurementOfSuccess {
...BusinessPlanningMeasurementOfSuccessFragment
}
}
}
}
Variables
{
"id": "00000006-0002-0000-0000-000000000000"
}
Response
{
"data": {
"opportunity": {
"id": "00000006-0002-0000-0000-000000000000",
"title": "abc123",
"description": "abc123",
"creatorId": "00000006-0002-0000-0000-000000000000",
"targetCompany": Company,
"opportunityType": OpportunityType,
"actualOutcome": OpportunityOutcome,
"actualOutcomeReason": OpportunityOutcomeReason,
"associatedOutcomeReasons": [
OpportunityOutcomeReasonCollection
],
"originationSource": OpportunityOriginationSource,
"originationSourceContact": Person,
"originationSourceCompany": Company,
"associatedPrincipals": [OpportunityLead],
"associatedContacts": [
OpportunityTargetCompanyContact
],
"stageInstances": [OpportunityStageInstance],
"estimatedCloseDate": "2007-12-03",
"dateOpened": "2007-12-03",
"actualCloseDate": "2007-12-03",
"associatedMatter": "xyz789",
"associatedInitiative": Initiative,
"activities": InitiativeActivityResults,
"practiceGroups": [PracticeGroup],
"industries": [Industry],
"workTypeId": "00000006-0002-0000-0000-000000000000",
"status": "open",
"isConfidential": true,
"shouldBeHidden": true,
"isCurrentUserInvolved": true,
"lead": Person,
"tags": [OpportunityTag],
"currentStage": OpportunityStageInstance,
"associatedInitiatives": [Initiative]
}
}
}
opportunityEventViews
Description
Retrieves a list of opportunity change-detection events (dateOpened, currentStage, and status changes) for external integrators polling for updates.
Response
Returns an OpportunityEventViewResults
Arguments
| Name | Description |
|---|---|
skip - Int
|
The starting index for pagination of opportunity events. Default = 0 |
limit - Int
|
The maximum number of opportunity events to retrieve. Default = 100 |
sort - [OpportunityEventViewSortInput!]
|
The sorting options for the opportunity events. |
filter - OpportunityEventViewFilterInput
|
The filter criteria for the opportunity events. |
Example
Query
query opportunityEventViews(
$skip: Int,
$limit: Int,
$sort: [OpportunityEventViewSortInput!],
$filter: OpportunityEventViewFilterInput
) {
opportunityEventViews(
skip: $skip,
limit: $limit,
sort: $sort,
filter: $filter
) {
totalModels
models {
eventType
eventDate
opportunityId
opportunity {
...OpportunityFragment
}
}
}
}
Variables
{
"skip": 0,
"limit": 100,
"sort": [OpportunityEventViewSortInput],
"filter": OpportunityEventViewFilterInput
}
Response
{
"data": {
"opportunityEventViews": {
"totalModels": 123,
"models": [OpportunityEventView]
}
}
}
people
Description
Retrieves a list of person contacts.
Response
Returns [Person]
Arguments
| Name | Description |
|---|---|
ids - [ID!]!
|
The list of person contact IDs to retrieve. |
Example
Query
query people($ids: [ID!]!) {
people(ids: $ids) {
id
displayName
contactEntity
notes {
allNotes {
...NoteResultsFragment
}
}
visibility
relationshipScore {
strength
value
maxValue
description
}
isEmployee
isPendingFirmContact
title
firstName
middleName
lastName
fullName
suffix
goesBy
currentJobTitle
currentEmployer {
id
displayName
contactEntity
visibility
notes {
...NotesFragment
}
name
alias
relationshipScore {
...ScoreFragment
}
isPendingFirmContact
addresses {
...AddressFragment
}
tags
contactTypes {
...ContactFolderContactTypeFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
assistantName
contactTypes {
id
name
}
tags
addresses {
id
type
usage
label
street
city
administrativeDivision
additional
country
postalCode
isGlobal
isMailingAddress
owningContactId
}
emailAddresses {
id
type
usage
address
label
owningContactId
isGlobal
}
phoneNumbers {
id
addressId
number
label
type
usage
owningContactId
isGlobal
}
additionalFieldValues {
totalModels
models {
...AdditionalFieldValueFragment
}
}
contactAdditionalFieldValues {
totalModels
models {
...ContactAdditionalFieldValueFragment
}
}
}
}
Variables
{
"ids": [
"00000006-0002-0000-0000-000000000000"
]
}
Response
{
"data": {
"people": [
{
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "abc123",
"contactEntity": "Any",
"notes": Notes,
"visibility": "unknown",
"relationshipScore": Score,
"isEmployee": false,
"isPendingFirmContact": false,
"title": "xyz789",
"firstName": "abc123",
"middleName": "xyz789",
"lastName": "abc123",
"fullName": "xyz789",
"suffix": "xyz789",
"goesBy": "xyz789",
"currentJobTitle": "xyz789",
"currentEmployer": Company,
"assistantName": "xyz789",
"contactTypes": [ContactFolderContactType],
"tags": ["xyz789"],
"addresses": [Address],
"emailAddresses": [EmailAddress],
"phoneNumbers": [PhoneNumber],
"additionalFieldValues": AdditionalFieldValueResults,
"contactAdditionalFieldValues": ContactAdditionalFieldValueResults
}
]
}
}
person
Description
Retrieves a person contact.
Response
Returns a Person
Arguments
| Name | Description |
|---|---|
id - ID!
|
The ID of the person contact to retrieve. |
Example
Query
query person($id: ID!) {
person(id: $id) {
id
displayName
contactEntity
notes {
allNotes {
...NoteResultsFragment
}
}
visibility
relationshipScore {
strength
value
maxValue
description
}
isEmployee
isPendingFirmContact
title
firstName
middleName
lastName
fullName
suffix
goesBy
currentJobTitle
currentEmployer {
id
displayName
contactEntity
visibility
notes {
...NotesFragment
}
name
alias
relationshipScore {
...ScoreFragment
}
isPendingFirmContact
addresses {
...AddressFragment
}
tags
contactTypes {
...ContactFolderContactTypeFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
assistantName
contactTypes {
id
name
}
tags
addresses {
id
type
usage
label
street
city
administrativeDivision
additional
country
postalCode
isGlobal
isMailingAddress
owningContactId
}
emailAddresses {
id
type
usage
address
label
owningContactId
isGlobal
}
phoneNumbers {
id
addressId
number
label
type
usage
owningContactId
isGlobal
}
additionalFieldValues {
totalModels
models {
...AdditionalFieldValueFragment
}
}
contactAdditionalFieldValues {
totalModels
models {
...ContactAdditionalFieldValueFragment
}
}
}
}
Variables
{
"id": "00000006-0002-0000-0000-000000000000"
}
Response
{
"data": {
"person": {
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "xyz789",
"contactEntity": "Any",
"notes": Notes,
"visibility": "unknown",
"relationshipScore": Score,
"isEmployee": false,
"isPendingFirmContact": false,
"title": "xyz789",
"firstName": "abc123",
"middleName": "abc123",
"lastName": "abc123",
"fullName": "xyz789",
"suffix": "abc123",
"goesBy": "xyz789",
"currentJobTitle": "abc123",
"currentEmployer": Company,
"assistantName": "abc123",
"contactTypes": [ContactFolderContactType],
"tags": ["abc123"],
"addresses": [Address],
"emailAddresses": [EmailAddress],
"phoneNumbers": [PhoneNumber],
"additionalFieldValues": AdditionalFieldValueResults,
"contactAdditionalFieldValues": ContactAdditionalFieldValueResults
}
}
}
practiceGroups
Description
Retrieves a list of practice groups.
Response
Returns a PracticeGroupResults
Example
Query
query practiceGroups {
practiceGroups {
totalModels
models {
id
name
}
}
}
Response
{
"data": {
"practiceGroups": {
"totalModels": 123,
"models": [PracticeGroup]
}
}
}
profile
Description
Retrieves a contact's profile information.
Response
Returns a ProfileResults
Arguments
| Name | Description |
|---|---|
contactId - ID!
|
The ID of the contact whose profile you want to retrieve. |
Example
Query
query profile($contactId: ID!) {
profile(contactId: $contactId) {
totalModels
models {
profileId
name
displayOrder
listingType
userCriterionIds
groupCriterionIds
contactTypeIds
profileItems {
...ProfileItemFragment
}
}
}
}
Variables
{
"contactId": "00000006-0002-0000-0000-000000000000"
}
Response
{
"data": {
"profile": {"totalModels": 987, "models": [Profile]}
}
}
regionalSettings
Description
Retrieve regional settings for the current user.
Response
Returns a RegionalSettings
Example
Query
query regionalSettings {
regionalSettings {
language {
id
code
name
}
country {
id
code
name
}
locale {
id
code
name
}
languages {
id
name
localName
isoCode
}
}
}
Response
{
"data": {
"regionalSettings": {
"language": RegionalSetting,
"country": RegionalSetting,
"locale": RegionalSetting,
"languages": [RegionalLanguage]
}
}
}
searchFirmContacts
Description
Retrieve firm contacts based on specified criteria.
Response
Returns a ContactResults
Arguments
| Name | Description |
|---|---|
skip - Int
|
The starting index for pagination. Default = 0 |
limit - Int
|
The maximum number of items to retrieve. Default = 100 |
sort - SortInput
|
Sorting options for results. |
filter - [ContactFilterInput]
|
Specifies the filter settings for the firm contacts. For ids, industryIds and contactTypeIds ContactFilterField options set the 'values' field. For remaining ContactFilterField options set the 'value' field. Special filter options:
|
Example
Query
query searchFirmContacts(
$skip: Int,
$limit: Int,
$sort: SortInput,
$filter: [ContactFilterInput]
) {
searchFirmContacts(
skip: $skip,
limit: $limit,
sort: $sort,
filter: $filter
) {
searchTerms {
term
firstName
lastName
company
emailAddress
}
resultsFrom
totalModels
models {
id
displayName
contactEntity
visibility
relationshipScore {
...ScoreFragment
}
tags
contactTypes {
...ContactFolderContactTypeFragment
}
addresses {
...AddressFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
notes {
...NotesFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
}
}
Variables
{
"skip": 0,
"limit": 100,
"sort": SortInput,
"filter": [ContactFilterInput]
}
Response
{
"data": {
"searchFirmContacts": {
"searchTerms": SearchTerms,
"resultsFrom": "Term",
"totalModels": 987,
"models": [Contact]
}
}
}
Mutations
addCompany
Description
Add a company contact.
Response
Returns a MutateCompanyResults
Arguments
| Name | Description |
|---|---|
input - AddCompanyInput!
|
Input for creating a new company. |
Example
Query
mutation addCompany($input: AddCompanyInput!) {
addCompany(input: $input) {
validationErrors {
propertyName
message
}
item {
id
displayName
contactEntity
visibility
notes {
...NotesFragment
}
name
alias
relationshipScore {
...ScoreFragment
}
isPendingFirmContact
addresses {
...AddressFragment
}
tags
contactTypes {
...ContactFolderContactTypeFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
}
}
Variables
{"input": AddCompanyInput}
Response
{
"data": {
"addCompany": {
"validationErrors": [ValidationErrors],
"item": Company
}
}
}
addCustomField
Description
Adds a new custom field.
Response
Returns an AddCustomFieldResults
Arguments
| Name | Description |
|---|---|
input - AddCustomFieldInput!
|
Example
Query
mutation addCustomField($input: AddCustomFieldInput!) {
addCustomField(input: $input) {
validationErrors {
propertyName
message
}
item {
id
displayName
description
required
isActive
canRemove
control {
...CustomFieldControlFragment
}
createDate
changeDate
displayOrder
}
}
}
Variables
{"input": AddCustomFieldInput}
Response
{
"data": {
"addCustomField": {
"validationErrors": [ValidationErrors],
"item": CustomField
}
}
}
addCustomFieldsData
Description
Adds custom field data values to an entity.
Response
Returns an AddCustomFieldValuesResults
Arguments
| Name | Description |
|---|---|
input - AddCustomFieldDataInput!
|
Example
Query
mutation addCustomFieldsData($input: AddCustomFieldDataInput!) {
addCustomFieldsData(input: $input) {
validationErrors {
propertyName
message
}
item {
customField {
...CustomFieldFragment
}
values {
...CustomFieldDataFragment
}
}
}
}
Variables
{"input": AddCustomFieldDataInput}
Response
{
"data": {
"addCustomFieldsData": {
"validationErrors": [ValidationErrors],
"item": [CustomFieldValue]
}
}
}
addCustomForm
Description
Adds a new custom form.
Response
Returns an AddCustomFormResults
Arguments
| Name | Description |
|---|---|
input - AddCustomFormInput!
|
Example
Query
mutation addCustomForm($input: AddCustomFormInput!) {
addCustomForm(input: $input) {
validationErrors {
propertyName
message
}
item {
id
name
description
entityType
isActive
canRemove
customFields {
...CustomFieldResultsFragment
}
customFieldValues {
...CustomFieldValueFragment
}
}
}
}
Variables
{"input": AddCustomFormInput}
Response
{
"data": {
"addCustomForm": {
"validationErrors": [ValidationErrors],
"item": CustomForm
}
}
}
addOpportunity
Description
Add an opportunity.
Response
Returns an Opportunity
Arguments
| Name | Description |
|---|---|
input - AddOpportunityInput!
|
Input for creating a new opportunity. |
Example
Query
mutation addOpportunity($input: AddOpportunityInput!) {
addOpportunity(input: $input) {
id
title
description
creatorId
targetCompany {
id
displayName
contactEntity
visibility
notes {
...NotesFragment
}
name
alias
relationshipScore {
...ScoreFragment
}
isPendingFirmContact
addresses {
...AddressFragment
}
tags
contactTypes {
...ContactFolderContactTypeFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
opportunityType {
id
name
description
isActive
}
actualOutcome {
id
name
description
reasons {
...OpportunityOutcomeReasonFragment
}
}
actualOutcomeReason {
id
name
description
outcomeId
isActive
}
associatedOutcomeReasons {
id
name
opportunityId
outcomeId
outcomeReason {
...OpportunityOutcomeReasonFragment
}
outcome {
...OpportunityOutcomeFragment
}
}
originationSource {
id
name
description
isActive
}
originationSourceContact {
id
displayName
contactEntity
notes {
...NotesFragment
}
visibility
relationshipScore {
...ScoreFragment
}
isEmployee
isPendingFirmContact
title
firstName
middleName
lastName
fullName
suffix
goesBy
currentJobTitle
currentEmployer {
...CompanyFragment
}
assistantName
contactTypes {
...ContactFolderContactTypeFragment
}
tags
addresses {
...AddressFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
originationSourceCompany {
id
displayName
contactEntity
visibility
notes {
...NotesFragment
}
name
alias
relationshipScore {
...ScoreFragment
}
isPendingFirmContact
addresses {
...AddressFragment
}
tags
contactTypes {
...ContactFolderContactTypeFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
associatedPrincipals {
opportunityId
accountName
isGroup
isPrimary
fullName
leadId
}
associatedContacts {
opportunityId
contactId
person {
...PersonFragment
}
isPrimary
}
stageInstances {
id
opportunityId
stageName
stageOrder
timeEntered
timeSpent
}
estimatedCloseDate
dateOpened
actualCloseDate
associatedMatter
associatedInitiative {
id
name
description
startDate
endDate
closedDate
status
creatorId
createdBy
progress
isDeleted
objective {
...ObjectiveFragment
}
companies {
...BusinessPlanningInitiativeCompanyFragment
}
locations {
...BusinessPlanningLocationFragment
}
involvedUsers {
...BusinessPlanningPersonFragment
}
companyEmployeeRelationships {
...BusinessPlanningConnectionResultsFragment
}
companyEmployees {
...CompanyEmployeeResultsFragment
}
tags {
...BusinessPlanningTagFragment
}
types {
...BusinessPlanningTypesFragment
}
activityCounts {
...InitiativeActivityCountResultsFragment
}
activities {
...InitiativeActivityResultsFragment
}
measurementOfSuccess {
...BusinessPlanningMeasurementOfSuccessFragment
}
}
activities {
skip
limit
sort {
...SortFragment
}
models {
...BusinessPlanningActivityFragment
}
totalModels
}
practiceGroups {
id
name
}
industries {
id
name
}
workTypeId
status
isConfidential
shouldBeHidden
isCurrentUserInvolved
lead {
id
displayName
contactEntity
notes {
...NotesFragment
}
visibility
relationshipScore {
...ScoreFragment
}
isEmployee
isPendingFirmContact
title
firstName
middleName
lastName
fullName
suffix
goesBy
currentJobTitle
currentEmployer {
...CompanyFragment
}
assistantName
contactTypes {
...ContactFolderContactTypeFragment
}
tags
addresses {
...AddressFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
tags {
type
displayName
}
currentStage {
id
opportunityId
stageName
stageOrder
timeEntered
timeSpent
}
associatedInitiatives {
id
name
description
startDate
endDate
closedDate
status
creatorId
createdBy
progress
isDeleted
objective {
...ObjectiveFragment
}
companies {
...BusinessPlanningInitiativeCompanyFragment
}
locations {
...BusinessPlanningLocationFragment
}
involvedUsers {
...BusinessPlanningPersonFragment
}
companyEmployeeRelationships {
...BusinessPlanningConnectionResultsFragment
}
companyEmployees {
...CompanyEmployeeResultsFragment
}
tags {
...BusinessPlanningTagFragment
}
types {
...BusinessPlanningTypesFragment
}
activityCounts {
...InitiativeActivityCountResultsFragment
}
activities {
...InitiativeActivityResultsFragment
}
measurementOfSuccess {
...BusinessPlanningMeasurementOfSuccessFragment
}
}
}
}
Variables
{"input": AddOpportunityInput}
Response
{
"data": {
"addOpportunity": {
"id": "00000006-0002-0000-0000-000000000000",
"title": "abc123",
"description": "xyz789",
"creatorId": "00000006-0002-0000-0000-000000000000",
"targetCompany": Company,
"opportunityType": OpportunityType,
"actualOutcome": OpportunityOutcome,
"actualOutcomeReason": OpportunityOutcomeReason,
"associatedOutcomeReasons": [
OpportunityOutcomeReasonCollection
],
"originationSource": OpportunityOriginationSource,
"originationSourceContact": Person,
"originationSourceCompany": Company,
"associatedPrincipals": [OpportunityLead],
"associatedContacts": [
OpportunityTargetCompanyContact
],
"stageInstances": [OpportunityStageInstance],
"estimatedCloseDate": "2007-12-03",
"dateOpened": "2007-12-03",
"actualCloseDate": "2007-12-03",
"associatedMatter": "xyz789",
"associatedInitiative": Initiative,
"activities": InitiativeActivityResults,
"practiceGroups": [PracticeGroup],
"industries": [Industry],
"workTypeId": "00000006-0002-0000-0000-000000000000",
"status": "open",
"isConfidential": true,
"shouldBeHidden": true,
"isCurrentUserInvolved": true,
"lead": Person,
"tags": [OpportunityTag],
"currentStage": OpportunityStageInstance,
"associatedInitiatives": [Initiative]
}
}
}
addOpportunityActivity
Description
Add an activity to one or more opportunities.
Response
Returns [AddOpportunityActivityResult!]!
Arguments
| Name | Description |
|---|---|
input - AddOpportunityActivityInput!
|
Input for adding an activity to one or more opportunities. |
Example
Query
mutation addOpportunityActivity($input: AddOpportunityActivityInput!) {
addOpportunityActivity(input: $input) {
opportunityId
activityId
}
}
Variables
{"input": AddOpportunityActivityInput}
Response
{
"data": {
"addOpportunityActivity": [
{
"opportunityId": "00000006-0002-0000-0000-000000000000",
"activityId": "00000006-0002-0000-0000-000000000000"
}
]
}
}
addPerson
Description
Add a person contact.
Response
Returns an AddPersonResults
Arguments
| Name | Description |
|---|---|
input - AddPersonInput!
|
Input for adding a new person. |
Example
Query
mutation addPerson($input: AddPersonInput!) {
addPerson(input: $input) {
status
validationErrors {
propertyName
message
}
item {
id
displayName
contactEntity
notes {
...NotesFragment
}
visibility
relationshipScore {
...ScoreFragment
}
isEmployee
isPendingFirmContact
title
firstName
middleName
lastName
fullName
suffix
goesBy
currentJobTitle
currentEmployer {
...CompanyFragment
}
assistantName
contactTypes {
...ContactFolderContactTypeFragment
}
tags
addresses {
...AddressFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
}
}
Variables
{"input": AddPersonInput}
Response
{
"data": {
"addPerson": {
"status": "NoChange",
"validationErrors": [ValidationErrors],
"item": Person
}
}
}
addPublicLocation
Description
Add a new location to a contact.
Response
Returns a MutateLocationResults
Arguments
| Name | Description |
|---|---|
input - AddLocationInput!
|
Input for creating a new contact location. |
Example
Query
mutation addPublicLocation($input: AddLocationInput!) {
addPublicLocation(input: $input) {
status
validationErrors {
propertyName
message
}
item {
id
displayName
contactEntity
visibility
relationshipScore {
...ScoreFragment
}
tags
contactTypes {
...ContactFolderContactTypeFragment
}
addresses {
...AddressFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
notes {
...NotesFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
}
}
Variables
{"input": AddLocationInput}
Response
{
"data": {
"addPublicLocation": {
"status": "NoChange",
"validationErrors": [ValidationErrors],
"item": Contact
}
}
}
changePublicContactLocation
Description
Update the location for a firm contact.
Response
Returns a MutateLocationResults
Arguments
| Name | Description |
|---|---|
input - LocationChangeInput!
|
Input for updating a contact's location. |
Example
Query
mutation changePublicContactLocation($input: LocationChangeInput!) {
changePublicContactLocation(input: $input) {
status
validationErrors {
propertyName
message
}
item {
id
displayName
contactEntity
visibility
relationshipScore {
...ScoreFragment
}
tags
contactTypes {
...ContactFolderContactTypeFragment
}
addresses {
...AddressFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
notes {
...NotesFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
}
}
Variables
{"input": LocationChangeInput}
Response
{
"data": {
"changePublicContactLocation": {
"status": "NoChange",
"validationErrors": [ValidationErrors],
"item": Contact
}
}
}
editPersonEmploymentInformation
Description
Update the employment information of a person.
Response
Returns a MutatePersonResults
Arguments
| Name | Description |
|---|---|
input - EditPersonEmploymentInformationInput!
|
Input for updating a person's employment information. |
Example
Query
mutation editPersonEmploymentInformation($input: EditPersonEmploymentInformationInput!) {
editPersonEmploymentInformation(input: $input) {
status
validationErrors {
propertyName
message
}
item {
id
displayName
contactEntity
notes {
...NotesFragment
}
visibility
relationshipScore {
...ScoreFragment
}
isEmployee
isPendingFirmContact
title
firstName
middleName
lastName
fullName
suffix
goesBy
currentJobTitle
currentEmployer {
...CompanyFragment
}
assistantName
contactTypes {
...ContactFolderContactTypeFragment
}
tags
addresses {
...AddressFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
}
}
Variables
{"input": EditPersonEmploymentInformationInput}
Response
{
"data": {
"editPersonEmploymentInformation": {
"status": "NoChange",
"validationErrors": [ValidationErrors],
"item": Person
}
}
}
patchOpportunityOriginationSource
Description
Add or update opportunity origination sources.
Response
Returns a PatchOpportunityOriginationSourceResult
Arguments
| Name | Description |
|---|---|
input - OpportunityOriginationSourceInput!
|
Input for adding or updating opportunity origination sources. |
Example
Query
mutation patchOpportunityOriginationSource($input: OpportunityOriginationSourceInput!) {
patchOpportunityOriginationSource(input: $input) {
validationErrors {
propertyName
message
}
addItems {
id
name
description
isActive
}
updateItems {
id
name
description
isActive
}
}
}
Variables
{"input": OpportunityOriginationSourceInput}
Response
{
"data": {
"patchOpportunityOriginationSource": {
"validationErrors": [ValidationErrors],
"addItems": [OpportunityOriginationSource],
"updateItems": [OpportunityOriginationSource]
}
}
}
patchOpportunityOutcomeReason
Description
Add or update opportunity outcome reasons.
Response
Returns a PatchOpportunityOutcomeReasonResult
Arguments
| Name | Description |
|---|---|
input - OpportunityOutcomeReasonInput!
|
Input for adding or updating opportunity outcome reasons. |
Example
Query
mutation patchOpportunityOutcomeReason($input: OpportunityOutcomeReasonInput!) {
patchOpportunityOutcomeReason(input: $input) {
validationErrors {
propertyName
message
}
addItems {
id
name
description
outcomeId
isActive
}
updateItems {
id
name
description
outcomeId
isActive
}
}
}
Variables
{"input": OpportunityOutcomeReasonInput}
Response
{
"data": {
"patchOpportunityOutcomeReason": {
"validationErrors": [ValidationErrors],
"addItems": [OpportunityOutcomeReason],
"updateItems": [OpportunityOutcomeReason]
}
}
}
patchOpportunityType
Description
Add or update opportunity types.
Response
Returns a PatchOpportunityTypeResult
Arguments
| Name | Description |
|---|---|
input - OpportunityTypeInput!
|
Input for adding or updating opportunity types. |
Example
Query
mutation patchOpportunityType($input: OpportunityTypeInput!) {
patchOpportunityType(input: $input) {
validationErrors {
propertyName
message
}
addItems {
id
name
description
isActive
}
updateItems {
id
name
description
isActive
}
}
}
Variables
{"input": OpportunityTypeInput}
Response
{
"data": {
"patchOpportunityType": {
"validationErrors": [ValidationErrors],
"addItems": [OpportunityType],
"updateItems": [OpportunityType]
}
}
}
removeCustomField
Description
Removes an existing custom field.
Response
Returns a RemoveCustomFieldResults
Arguments
| Name | Description |
|---|---|
id - ID!
|
The ID of the custom field to remove. |
Example
Query
mutation removeCustomField($id: ID!) {
removeCustomField(id: $id) {
validationErrors {
propertyName
message
}
item
}
}
Variables
{
"id": "00000006-0002-0000-0000-000000000000"
}
Response
{
"data": {
"removeCustomField": {
"validationErrors": [ValidationErrors],
"item": false
}
}
}
removeCustomForm
Description
Removes an existing custom form.
Response
Returns a RemoveCustomFormResults
Arguments
| Name | Description |
|---|---|
id - ID!
|
The ID of the custom form to remove. |
Example
Query
mutation removeCustomForm($id: ID!) {
removeCustomForm(id: $id) {
validationErrors {
propertyName
message
}
item
}
}
Variables
{
"id": "00000006-0002-0000-0000-000000000000"
}
Response
{
"data": {
"removeCustomForm": {
"validationErrors": [ValidationErrors],
"item": false
}
}
}
removeOpportunity
Description
Remove an opportunity.
Response
Returns a RemoveOpportunityResult
Arguments
| Name | Description |
|---|---|
id - ID!
|
The ID of the opportunity to remove. |
Example
Query
mutation removeOpportunity($id: ID!) {
removeOpportunity(id: $id) {
isSuccessful
validationErrors {
propertyName
message
}
}
}
Variables
{
"id": "00000006-0002-0000-0000-000000000000"
}
Response
{
"data": {
"removeOpportunity": {
"isSuccessful": true,
"validationErrors": [ValidationErrors]
}
}
}
updateContactAdditionalFields
Description
Updates language and gender settings for a person contact. You must have language-specific information enabled in firm settings.
Response
Returns a MutatePersonResults
Arguments
| Name | Description |
|---|---|
input - UpdateContactAdditionalFieldsInput!
|
Input for updating a person's language and gender settings. |
Example
Query
mutation updateContactAdditionalFields($input: UpdateContactAdditionalFieldsInput!) {
updateContactAdditionalFields(input: $input) {
status
validationErrors {
propertyName
message
}
item {
id
displayName
contactEntity
notes {
...NotesFragment
}
visibility
relationshipScore {
...ScoreFragment
}
isEmployee
isPendingFirmContact
title
firstName
middleName
lastName
fullName
suffix
goesBy
currentJobTitle
currentEmployer {
...CompanyFragment
}
assistantName
contactTypes {
...ContactFolderContactTypeFragment
}
tags
addresses {
...AddressFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
}
}
Variables
{"input": UpdateContactAdditionalFieldsInput}
Response
{
"data": {
"updateContactAdditionalFields": {
"status": "NoChange",
"validationErrors": [ValidationErrors],
"item": Person
}
}
}
updateCustomField
Description
Updates an existing custom field.
Response
Returns an UpdateCustomFieldResults
Arguments
| Name | Description |
|---|---|
input - UpdateCustomFieldInput!
|
Example
Query
mutation updateCustomField($input: UpdateCustomFieldInput!) {
updateCustomField(input: $input) {
validationErrors {
propertyName
message
}
item {
id
displayName
description
required
isActive
canRemove
control {
...CustomFieldControlFragment
}
createDate
changeDate
displayOrder
}
}
}
Variables
{"input": UpdateCustomFieldInput}
Response
{
"data": {
"updateCustomField": {
"validationErrors": [ValidationErrors],
"item": CustomField
}
}
}
updateCustomForm
Description
Updates an existing custom form.
Response
Returns an UpdateCustomFormResults
Arguments
| Name | Description |
|---|---|
input - UpdateCustomFormInput!
|
Example
Query
mutation updateCustomForm($input: UpdateCustomFormInput!) {
updateCustomForm(input: $input) {
validationErrors {
propertyName
message
}
item {
id
name
description
entityType
isActive
canRemove
customFields {
...CustomFieldResultsFragment
}
customFieldValues {
...CustomFieldValueFragment
}
}
}
}
Variables
{"input": UpdateCustomFormInput}
Response
{
"data": {
"updateCustomForm": {
"validationErrors": [ValidationErrors],
"item": CustomForm
}
}
}
updateCustomStandardField
Description
Updates an existing standard field.
Response
Returns an UpdateCustomStandardFieldResult
Arguments
| Name | Description |
|---|---|
input - UpdateCustomStandardFieldInput!
|
Example
Query
mutation updateCustomStandardField($input: UpdateCustomStandardFieldInput!) {
updateCustomStandardField(input: $input) {
validationErrors {
propertyName
message
}
item
}
}
Variables
{"input": UpdateCustomStandardFieldInput}
Response
{
"data": {
"updateCustomStandardField": {
"validationErrors": [ValidationErrors],
"item": true
}
}
}
updateListContactAdditionalFields
Description
Update list-specific additional fields for a contact.
Response
Returns a MutateAdditionalFieldResults
Arguments
| Name | Description |
|---|---|
input - UpdateListContactAdditionalFieldInput!
|
Input for updating a list contact's additional fields. |
Example
Query
mutation updateListContactAdditionalFields($input: UpdateListContactAdditionalFieldInput!) {
updateListContactAdditionalFields(input: $input) {
models {
fieldId
valueId
isSuccessful
failureReason
}
}
}
Variables
{"input": UpdateListContactAdditionalFieldInput}
Response
{
"data": {
"updateListContactAdditionalFields": {
"models": [UpdateListContactAdditionalFieldResults]
}
}
}
updateOpportunityConfidential
Description
Update the confidentiality flag of an opportunity.
Response
Returns an UpdateOpportunityConfidentialResult
Arguments
| Name | Description |
|---|---|
input - UpdateOpportunityConfidentialInput!
|
Input for updating the confidentiality flag of an opportunity. |
Example
Query
mutation updateOpportunityConfidential($input: UpdateOpportunityConfidentialInput!) {
updateOpportunityConfidential(input: $input) {
opportunityId
isConfidential
validationErrors {
propertyName
message
}
}
}
Variables
{"input": UpdateOpportunityConfidentialInput}
Response
{
"data": {
"updateOpportunityConfidential": {
"opportunityId": "00000006-0002-0000-0000-000000000000",
"isConfidential": false,
"validationErrors": [ValidationErrors]
}
}
}
updateOpportunityDetails
Description
Update the details of an opportunity.
Response
Returns an UpdateOpportunityResult
Arguments
| Name | Description |
|---|---|
input - UpdateOpportunityDetailsInput!
|
Input for updating the details of an opportunity. |
Example
Query
mutation updateOpportunityDetails($input: UpdateOpportunityDetailsInput!) {
updateOpportunityDetails(input: $input) {
opportunityId
}
}
Variables
{"input": UpdateOpportunityDetailsInput}
Response
{
"data": {
"updateOpportunityDetails": {
"opportunityId": "00000006-0002-0000-0000-000000000000"
}
}
}
updateOpportunityLinks
Description
Update the links associated with an opportunity.
Response
Returns an UpdateOpportunityValidationResult
Arguments
| Name | Description |
|---|---|
input - UpdateOpportunityLinksInput!
|
Input for updating the links associated with an opportunity. |
Example
Query
mutation updateOpportunityLinks($input: UpdateOpportunityLinksInput!) {
updateOpportunityLinks(input: $input) {
item {
opportunityId
}
validationErrors {
propertyName
message
}
}
}
Variables
{"input": UpdateOpportunityLinksInput}
Response
{
"data": {
"updateOpportunityLinks": {
"item": UpdateOpportunityResult,
"validationErrors": [ValidationErrors]
}
}
}
updateOpportunityLocations
Description
Update the locations of an opportunity.
Response
Returns an UpdateOpportunityResult
Arguments
| Name | Description |
|---|---|
input - UpdateOpportunityLocationsInput!
|
Input for updating the locations of an opportunity. |
Example
Query
mutation updateOpportunityLocations($input: UpdateOpportunityLocationsInput!) {
updateOpportunityLocations(input: $input) {
opportunityId
}
}
Variables
{"input": UpdateOpportunityLocationsInput}
Response
{
"data": {
"updateOpportunityLocations": {
"opportunityId": "00000006-0002-0000-0000-000000000000"
}
}
}
updateOpportunityPeople
Description
Update the people associated with an opportunity.
Response
Returns an UpdateObjectResult
Arguments
| Name | Description |
|---|---|
input - UpdateOpportunityPeopleInput!
|
Input for updating the people associated with an opportunity. |
Example
Query
mutation updateOpportunityPeople($input: UpdateOpportunityPeopleInput!) {
updateOpportunityPeople(input: $input) {
id
validationErrors {
propertyName
message
}
}
}
Variables
{"input": UpdateOpportunityPeopleInput}
Response
{
"data": {
"updateOpportunityPeople": {
"id": "00000006-0002-0000-0000-000000000000",
"validationErrors": [ValidationErrors]
}
}
}
updateOpportunityStageInstances
Description
Update the stage instance information of an opportunity.
Response
Returns an UpdateOpportunityResult
Arguments
| Name | Description |
|---|---|
input - UpdateOpportunityStageInstanceInput!
|
Input for updating the stage instance of an opportunity. |
Example
Query
mutation updateOpportunityStageInstances($input: UpdateOpportunityStageInstanceInput!) {
updateOpportunityStageInstances(input: $input) {
opportunityId
}
}
Variables
{"input": UpdateOpportunityStageInstanceInput}
Response
{
"data": {
"updateOpportunityStageInstances": {
"opportunityId": "00000006-0002-0000-0000-000000000000"
}
}
}
updateOpportunityStageTemplates
Description
Update the stage templates available to an opportunity.
Response
Returns an UpdateObjectResult
Arguments
| Name | Description |
|---|---|
input - UpdateOpportunityStageTemplateInput!
|
The associated template id and updated templates. |
Example
Query
mutation updateOpportunityStageTemplates($input: UpdateOpportunityStageTemplateInput!) {
updateOpportunityStageTemplates(input: $input) {
id
validationErrors {
propertyName
message
}
}
}
Variables
{"input": UpdateOpportunityStageTemplateInput}
Response
{
"data": {
"updateOpportunityStageTemplates": {
"id": "00000006-0002-0000-0000-000000000000",
"validationErrors": [ValidationErrors]
}
}
}
updateOpportunityStatus
Description
Update the status of an opportunity.
Response
Returns an UpdateObjectResult
Arguments
| Name | Description |
|---|---|
input - UpdateOpportunityStatusInput!
|
Input for updating the status of an opportunity. |
Example
Query
mutation updateOpportunityStatus($input: UpdateOpportunityStatusInput!) {
updateOpportunityStatus(input: $input) {
id
validationErrors {
propertyName
message
}
}
}
Variables
{"input": UpdateOpportunityStatusInput}
Response
{
"data": {
"updateOpportunityStatus": {
"id": "00000006-0002-0000-0000-000000000000",
"validationErrors": [ValidationErrors]
}
}
}
updateOpportunitySummary
Description
Update the summary of an opportunity.
Response
Returns an UpdateOpportunityResult
Arguments
| Name | Description |
|---|---|
input - UpdateOpportunitySummaryInput!
|
Input for updating the summary of an opportunity. |
Example
Query
mutation updateOpportunitySummary($input: UpdateOpportunitySummaryInput!) {
updateOpportunitySummary(input: $input) {
opportunityId
}
}
Variables
{"input": UpdateOpportunitySummaryInput}
Response
{
"data": {
"updateOpportunitySummary": {
"opportunityId": "00000006-0002-0000-0000-000000000000"
}
}
}
updatePublicCompany
Description
Update a firm company contact.
Response
Returns a MutateCompanyResults
Arguments
| Name | Description |
|---|---|
input - UpdatePublicCompanyInput!
|
Input for updating an existing firm company. |
Example
Query
mutation updatePublicCompany($input: UpdatePublicCompanyInput!) {
updatePublicCompany(input: $input) {
validationErrors {
propertyName
message
}
item {
id
displayName
contactEntity
visibility
notes {
...NotesFragment
}
name
alias
relationshipScore {
...ScoreFragment
}
isPendingFirmContact
addresses {
...AddressFragment
}
tags
contactTypes {
...ContactFolderContactTypeFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
}
}
Variables
{"input": UpdatePublicCompanyInput}
Response
{
"data": {
"updatePublicCompany": {
"validationErrors": [ValidationErrors],
"item": Company
}
}
}
updatePublicPerson
Description
Update an existing firm person.
Response
Returns a MutatePersonResults
Arguments
| Name | Description |
|---|---|
input - UpdatePublicPersonInput!
|
Input for updating an existing firm person. |
Example
Query
mutation updatePublicPerson($input: UpdatePublicPersonInput!) {
updatePublicPerson(input: $input) {
status
validationErrors {
propertyName
message
}
item {
id
displayName
contactEntity
notes {
...NotesFragment
}
visibility
relationshipScore {
...ScoreFragment
}
isEmployee
isPendingFirmContact
title
firstName
middleName
lastName
fullName
suffix
goesBy
currentJobTitle
currentEmployer {
...CompanyFragment
}
assistantName
contactTypes {
...ContactFolderContactTypeFragment
}
tags
addresses {
...AddressFragment
}
emailAddresses {
...EmailAddressFragment
}
phoneNumbers {
...PhoneNumberFragment
}
additionalFieldValues {
...AdditionalFieldValueResultsFragment
}
contactAdditionalFieldValues {
...ContactAdditionalFieldValueResultsFragment
}
}
}
}
Variables
{"input": UpdatePublicPersonInput}
Response
{
"data": {
"updatePublicPerson": {
"status": "NoChange",
"validationErrors": [ValidationErrors],
"item": Person
}
}
}
Types
Activity
Description
Represents an activity.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the activity. |
type - String
|
The type of the activity. |
typeId - ID
|
The ID of the activity type. |
activityClass - ActivityClass
|
The class of the activity. |
typeGroup - String
|
The group of the activity type. |
activityStartDate - DateTime
|
The start date and time of the activity. |
lastEditedDate - Date
|
The date when the activity was last edited. |
subject - String
|
The subject of the activity. |
summary - String
|
The summary of the activity. |
location - String
|
The location of the activity. |
linkedActivityContacts - [ActivityContact]
|
Retrieves the contacts linked to the activity, filtered by the specified contact type. |
Arguments
|
|
regarding - String
|
The module or context to which this activity relates (Contacts Only, Lists, etc.). |
originator - Person
|
The person who initiated the activity. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"type": "xyz789",
"typeId": "00000006-0002-0000-0000-000000000000",
"activityClass": "Activity",
"typeGroup": "abc123",
"activityStartDate": "2007-12-03T10:15:30Z",
"lastEditedDate": "2007-12-03",
"subject": "xyz789",
"summary": "abc123",
"location": "xyz789",
"linkedActivityContacts": [ActivityContact],
"regarding": "xyz789",
"originator": Person
}
ActivityClass
Description
Type of activity.
Values
| Enum Value | Description |
|---|---|
|
|
A standard activity. |
|
|
An appointment synchronized from Outlook. |
Example
"Activity"
ActivityCompany
ActivityContact
Description
Represents a contact associated with an activity.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the contact. |
Possible Types
| ActivityContact Types |
|---|
Example
{
"id": "00000006-0002-0000-0000-000000000000"
}
ActivityContactType
Description
Types of contacts that can be associated with activities.
Values
| Enum Value | Description |
|---|---|
|
|
Indicates a person associated with an activity. |
|
|
Indicates a company associated with an activity. |
|
|
Indicates an unknown type of contact associated with an activity. |
Example
"Person"
ActivityPerson
Description
Represents a person associated with an activity.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the person linked to the activity. |
fullName - String
|
The full name of the person linked to the activity. |
primaryEmail - String
|
The primary email address of the person linked to the activity. |
company - ActivityCompany
|
The company where the person is employed. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"fullName": "abc123",
"primaryEmail": "xyz789",
"company": ActivityCompany
}
ActivityUnknown
Description
Represents an unknown type of contact associated with an activity.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "abc123"
}
AddCompanyInput
Description
Input for creating a new company contact.
Fields
| Input Field | Description |
|---|---|
companyName - String
|
The name for the company. |
alias - String
|
The common name or alias for the company. |
primaryPhone - String
|
The primary phone number for the company. |
secondaryPhone - String
|
The secondary phone number for the company. |
faxNumber - String
|
The fax number for the company. |
mobilePhone - String
|
The mobile phone number for the company. |
pagerNumber - String
|
The pager number for the company. |
emailAddress - String
|
The email address for the company. |
website - String
|
The website URL for the company. |
folderContactTypes - [ID]
|
A list of ContactType IDs to associate to the company. |
businessAddress - AddContactWithLabelAdditionalFieldAddressInput
|
The business address for the company. |
otherAddress - AddContactAddressInput
|
An alternative address for the company. |
mailingAddress - MailingAddressType
|
Determines which address should be used as the mailing address for the company. |
Example
{
"companyName": "xyz789",
"alias": "abc123",
"primaryPhone": "xyz789",
"secondaryPhone": "abc123",
"faxNumber": "abc123",
"mobilePhone": "xyz789",
"pagerNumber": "xyz789",
"emailAddress": "abc123",
"website": "abc123",
"folderContactTypes": [
"00000006-0002-0000-0000-000000000000"
],
"businessAddress": AddContactWithLabelAdditionalFieldAddressInput,
"otherAddress": AddContactAddressInput,
"mailingAddress": "None"
}
AddContactAddressInput
Description
Input for adding a new address to a contact.
Fields
| Input Field | Description |
|---|---|
street - String
|
The street for the address. |
city - String
|
The city for the address (city, town, village, etc.). |
administrativeDivision - String
|
The administrative division for the address. This represents a state, province, governorate, department, or similar regional division depending on the country. This field may not be applicable for all countries. |
country - String
|
The country for the address. |
postalCode - String
|
The ZIP or postal code for the address. This field may not be applicable for all countries. |
Example
{
"street": "abc123",
"city": "xyz789",
"administrativeDivision": "xyz789",
"country": "xyz789",
"postalCode": "abc123"
}
AddContactWithLabelAdditionalFieldAddressInput
Description
Input for adding a new business address to a contact.
Fields
| Input Field | Description |
|---|---|
label - String
|
The label for the address. Only applicable for business addresses. |
street - String
|
The street for the address. |
city - String
|
The city for the address (city, town, village, etc.). |
administrativeDivision - String
|
The administrative division for the address. This represents a state, province, governorate, department, or similar regional division depending on the country. This field may not be applicable for all countries. |
country - String
|
The country for the address. |
postalCode - String
|
The ZIP or postal code for the address. This field may not be applicable for all countries. |
additionalField - String
|
Additional information for the address. Only applicable for business addresses. |
Example
{
"label": "abc123",
"street": "abc123",
"city": "xyz789",
"administrativeDivision": "xyz789",
"country": "xyz789",
"postalCode": "xyz789",
"additionalField": "abc123"
}
AddCustomFieldDataInput
Description
Input for adding new custom field data.
Fields
| Input Field | Description |
|---|---|
formId - ID!
|
The ID of the parent custom form. |
entityId - ID!
|
The ID of the entity the values apply to. |
customFieldValues - [CustomFieldValueInput]!
|
The list of custom field values. |
Example
{
"formId": "00000006-0002-0000-0000-000000000000",
"entityId": "00000006-0002-0000-0000-000000000000",
"customFieldValues": [CustomFieldValueInput]
}
AddCustomFieldInput
Description
Input for creating a new custom field.
Fields
| Input Field | Description |
|---|---|
formId - ID!
|
The ID of the parent custom form. |
displayName - String!
|
The display name for the custom field. |
description - String
|
The description for the custom field. |
controlType - CustomFieldControlType!
|
The control type for the custom field. |
required - Boolean
|
Set to true to make the custom field required. |
maxSize - Int
|
The maximum size for the custom field. |
currencyMaxAmount - Decimal
|
The maximum currency amount for the custom field. |
enumInput - CustomFieldEnumInput
|
The enum options for the custom field. |
isActive - Boolean
|
Set to true to make the custom field active. Default = false |
Example
{
"formId": "00000006-0002-0000-0000-000000000000",
"displayName": "abc123",
"description": "xyz789",
"controlType": "TextArea",
"required": false,
"maxSize": 123,
"currencyMaxAmount": Decimal,
"enumInput": CustomFieldEnumInput,
"isActive": true
}
AddCustomFieldResults
Description
Represents the result of adding a custom field.
Fields
| Field Name | Description |
|---|---|
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
item - CustomField
|
The created custom field. |
Example
{
"validationErrors": [ValidationErrors],
"item": CustomField
}
AddCustomFieldValuesResults
Description
Represents the result of adding custom field data values.
Fields
| Field Name | Description |
|---|---|
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
item - [CustomFieldValue]
|
The list of created custom field values. |
Example
{
"validationErrors": [ValidationErrors],
"item": [CustomFieldValue]
}
AddCustomFormInput
Description
Input for creating a new custom form.
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name for the custom form. |
isActive - Boolean!
|
Set to true to make the custom form active. |
description - String
|
The description for the custom form. |
entityType - CustomFieldEntityType!
|
The entity type for the custom form. |
Example
{
"name": "abc123",
"isActive": false,
"description": "abc123",
"entityType": "opportunity"
}
AddCustomFormResults
Description
Represents the result of adding a custom form.
Fields
| Field Name | Description |
|---|---|
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
item - CustomForm
|
The created custom form. |
Example
{
"validationErrors": [ValidationErrors],
"item": CustomForm
}
AddLocationInput
Description
Input for creating a new contact location.
Fields
| Input Field | Description |
|---|---|
contactId - ID!
|
The ID of the contact to associate with the location. |
relationshipType - UsageTypes
|
The relationship type for the location (AlternateBusiness, AlternateHome, etc.). |
description - String
|
The description for the location. |
addressType - AddressTypes
|
The address type for the location. |
street - String
|
The street for the location. |
city - String
|
The city for the location (city, town, village, etc.). |
administrativeDivision - String
|
The administrative division for the location. This represents a state, province, governorate, department, or similar regional division depending on the country. This field may not be applicable for all countries. |
postalCode - String
|
The ZIP or postal code for the location. This field may not be applicable for all countries. |
country - String
|
The country for the location. |
phoneNumber - String
|
The phone number for the location. |
faxNumber - String
|
The fax number for the location. |
Example
{
"contactId": "00000006-0002-0000-0000-000000000000",
"relationshipType": "AlternateBusiness",
"description": "abc123",
"addressType": "Street",
"street": "xyz789",
"city": "xyz789",
"administrativeDivision": "abc123",
"postalCode": "abc123",
"country": "abc123",
"phoneNumber": "abc123",
"faxNumber": "xyz789"
}
AddOpportunityActivityInput
Description
Input for adding an activity to one or more opportunities.
Example
{
"activityId": "00000006-0002-0000-0000-000000000000",
"opportunityIds": [
"00000006-0002-0000-0000-000000000000"
]
}
AddOpportunityActivityResult
Description
Represents the result of adding an activity to an opportunity.
Example
{
"opportunityId": "00000006-0002-0000-0000-000000000000",
"activityId": "00000006-0002-0000-0000-000000000000"
}
AddOpportunityInput
Description
Input for creating a new opportunity.
Fields
| Input Field | Description |
|---|---|
title - String!
|
The title of the opportunity. |
description - String
|
The description of the opportunity. |
targetClientId - ID!
|
The ID of the target company for the opportunity. |
opportunityTypeId - ID!
|
The ID of the opportunity type. |
isConfidential - Boolean
|
Indicates whether the opportunity is confidential. Default = false |
actualOutcomeId - ID
|
The ID of the actual outcome for the opportunity. |
actualOutcomeReasonId - ID
|
The ID of the actual outcome reason for the opportunity. |
opportunityOutcomeId - ID
|
The ID of the outcome for the opportunity. |
opportunityOutcomeReasonId - ID
|
The ID of the outcome reason for the opportunity. |
originationSourceContactId - ID
|
The ID of the origination source contact for the opportunity. |
originationSourceCompanyId - ID
|
The ID of the origination source company (referred-by company) for the opportunity. |
originationSourceId - ID
|
The ID of the origination source for the opportunity. |
estimatedCompleteDate - Date
|
The estimated close date for the opportunity. |
actualOpenedDate - Date
|
The date the opportunity was opened. |
actualCloseDate - DateTime
|
The date the opportunity was closed. |
projectedRevenue - MoneyInput
|
The projected revenue for the opportunity. |
practiceGroupId - ID
|
The ID of the practice group for the opportunity. |
industryTypeId - ID
|
The ID of the industry for the opportunity. |
associatedPrincipals - [OpportunityTeamMemberInput!]!
|
The list of team members associated with this opportunity. |
associatedContacts - [OpportunityTargetCompanyContactInput!]
|
The list of target company contacts associated with this opportunity. |
practiceGroups - [ID]
|
The list of IDs of the practice groups for the opportunity. |
industries - [ID]
|
The list of IDs of the industries for the opportunity. |
workTypeId - ID
|
The ID of the work type for the opportunity. |
associatedInitiativeId - ID
|
The ID of the initiative associated with the opportunity. |
locations - [LocationInput!]
|
The list of locations for the opportunity. |
opportunityLinks - [OpportunityLinkInput!]
|
The list of links associated with the opportunity. |
Example
{
"title": "abc123",
"description": "abc123",
"targetClientId": "00000006-0002-0000-0000-000000000000",
"opportunityTypeId": "00000006-0002-0000-0000-000000000000",
"isConfidential": true,
"actualOutcomeId": "00000006-0002-0000-0000-000000000000",
"actualOutcomeReasonId": "00000006-0002-0000-0000-000000000000",
"opportunityOutcomeId": "00000006-0002-0000-0000-000000000000",
"opportunityOutcomeReasonId": "00000006-0002-0000-0000-000000000000",
"originationSourceContactId": "00000006-0002-0000-0000-000000000000",
"originationSourceCompanyId": "00000006-0002-0000-0000-000000000000",
"originationSourceId": "00000006-0002-0000-0000-000000000000",
"estimatedCompleteDate": "2007-12-03",
"actualOpenedDate": "2007-12-03",
"actualCloseDate": "2007-12-03T10:15:30Z",
"projectedRevenue": MoneyInput,
"practiceGroupId": "00000006-0002-0000-0000-000000000000",
"industryTypeId": "00000006-0002-0000-0000-000000000000",
"associatedPrincipals": [OpportunityTeamMemberInput],
"associatedContacts": [
OpportunityTargetCompanyContactInput
],
"practiceGroups": [
"00000006-0002-0000-0000-000000000000"
],
"industries": [
"00000006-0002-0000-0000-000000000000"
],
"workTypeId": "00000006-0002-0000-0000-000000000000",
"associatedInitiativeId": "00000006-0002-0000-0000-000000000000",
"locations": [LocationInput],
"opportunityLinks": [OpportunityLinkInput]
}
AddOpportunityOriginationSourceInput
Description
Input for creating a new opportunity origination source.
Example
{
"name": "xyz789",
"description": "abc123",
"isActive": false
}
AddOpportunityOutcomeReasonInput
Description
Input for creating a new opportunity outcome reason.
Fields
| Input Field | Description |
|---|---|
outcomeId - ID!
|
The ID of the outcome for this reason. |
name - String!
|
The name of the opportunity outcome reason. |
description - String
|
The description of the opportunity outcome reason. |
isActive - Boolean
|
Indicates whether the opportunity outcome reason is active. Default = true |
Example
{
"outcomeId": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"description": "xyz789",
"isActive": true
}
AddOpportunityTypeInput
Description
Input for creating a new opportunity type.
Example
{
"name": "xyz789",
"description": "xyz789",
"isActive": false
}
AddPersonInput
Description
Input for creating a new person contact.
Fields
| Input Field | Description |
|---|---|
firstName - String
|
The first name for the person. |
lastName - String
|
The last name for the person. |
title - String
|
The salutational title for the person (Mr., Mrs., Dr., etc.). |
suffix - String
|
The suffix for the person (Jr., M.D., etc.). |
middleName - String
|
The middle name for the person. |
goesBy - String
|
The preferred name or nickname for the person. |
primaryPhone - String
|
The primary phone number for the person. |
companyPhone - String
|
The company phone number for the person. |
faxNumber - String
|
The fax number for the person. |
mobilePhone - String
|
The mobile phone number for the person. |
otherPhone - String
|
An additional phone number for the person. |
pagerNumber - String
|
The pager number for the person. |
emailAddress - String
|
The email address for the person. |
website - String
|
The website URL for the person. |
assistantName - String
|
The name of the person's assistant. |
assistantPhone - String
|
The phone number of the person's assistant. |
companyName - String
|
The name of the company where the person is employed. |
companyId - ID
|
The ID of the company where the person is employed. |
homePhone - String
|
The home phone number for the person. |
homeFax - String
|
The home fax number for the person. |
homeEmailAddress - String
|
The home email address for the person. |
otherEmailAddress - String
|
An additional email address for the person. |
jobTitle - String
|
The job title for the person. |
folderContactTypes - [ID]
|
A list of contact type IDs to associate to the person. |
businessAddress - AddContactWithLabelAdditionalFieldAddressInput
|
The business address for the person. |
otherAddress - AddContactAddressInput
|
An alternative address for the person. |
homeAddress - AddContactAddressInput
|
The home address for the person. |
contactAdditionalFields - [AdditionalField]
|
The language and gender settings for the person. You must have language-specific information enabled in firm settings. |
mailingAddress - MailingAddressType
|
Specifies which address should be used as the mailing address for the person. |
Example
{
"firstName": "xyz789",
"lastName": "xyz789",
"title": "abc123",
"suffix": "abc123",
"middleName": "abc123",
"goesBy": "abc123",
"primaryPhone": "xyz789",
"companyPhone": "xyz789",
"faxNumber": "abc123",
"mobilePhone": "xyz789",
"otherPhone": "xyz789",
"pagerNumber": "xyz789",
"emailAddress": "abc123",
"website": "xyz789",
"assistantName": "abc123",
"assistantPhone": "xyz789",
"companyName": "abc123",
"companyId": "00000006-0002-0000-0000-000000000000",
"homePhone": "abc123",
"homeFax": "xyz789",
"homeEmailAddress": "xyz789",
"otherEmailAddress": "xyz789",
"jobTitle": "abc123",
"folderContactTypes": [
"00000006-0002-0000-0000-000000000000"
],
"businessAddress": AddContactWithLabelAdditionalFieldAddressInput,
"otherAddress": AddContactAddressInput,
"homeAddress": AddContactAddressInput,
"contactAdditionalFields": [AdditionalField],
"mailingAddress": "None"
}
AddPersonResults
Fields
| Field Name | Description |
|---|---|
status - ResultCode
|
Status of the person creation. |
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
item - Person
|
The newly added person contact. |
Example
{
"status": "NoChange",
"validationErrors": [ValidationErrors],
"item": Person
}
AdditionalField
Description
Input for creating or updating an additional field value.
Fields
| Input Field | Description |
|---|---|
fieldId - ID!
|
The ID of the additional field definition. |
valueId - ID
|
The ID of the additional field value to update. Can be null for new values. |
lastEditDate - DateTime
|
The date and time when the field value was last edited in ISO 8601 format (e.g., 2024-11-07T14:01:32.247). For updating existing values, this must match the current lastEditDate value of the field. Can be null when creating new values. |
value - String!
|
The value must adhere to the following requirements by fieldDataType:
|
qualification - String
|
The qualification or secondary value for the field. |
fieldDataType - String!
|
The data type for the field. Options include: 'date', 'list', 'user', 'integer', 'decimal', 'boolean' or 'text'. |
Example
{
"fieldId": "00000006-0002-0000-0000-000000000000",
"valueId": "00000006-0002-0000-0000-000000000000",
"lastEditDate": "2007-12-03T10:15:30Z",
"value": "xyz789",
"qualification": "abc123",
"fieldDataType": "xyz789"
}
AdditionalFieldDataType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"integer"
AdditionalFieldDefinition
Description
Represents an additional field definition.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the additional field definition. |
name - String
|
The display name of the additional field definition. |
description - String
|
The description of the additional field definition. |
dataTypeDisplayName - String
|
The display name of the data type the additional field definition supports (List, Decimal, Text, etc.). |
fieldDataType - AdditionalFieldDataType
|
The data type the additional field definition supports. |
listDataType - AdditionalFieldListDataType
|
The options for a list type additional field. |
allowsSecondaryField - Boolean
|
Indicates whether a secondary field is allowed. |
secondaryFieldName - String
|
The name of the secondary field. |
allowsMultipleValues - Boolean
|
Indicates whether multiple values are allowed. |
booleanDataTypeTrueValue - String
|
The string representation of a true value for a boolean type additional field (Yes, True, Attending, etc.). |
booleanDataTypeFalseValue - String
|
The string representation of a false value for a boolean type additional field (No, False, Not Attending, etc.). |
numericDataTypeMaxValue - Float
|
The maximum value allowed for a integer or decimal type additional field. |
numericDataTypeMinValue - Float
|
The minimum value allowed for a integer or decimal type additional field. |
decimalDataTypePrecision - Int
|
The number of decimal places allowed for the decimal type additional field. |
stringDataTypeMaxLength - Int
|
The maximum character length allowed for the string type additional field. |
stringDataTypeMultiLine - Boolean
|
Indicates whether multiple lines are allowed for the string type additional field. |
userDataTypeUserProfessional - AdditionalFieldUserDataTypeUserType
|
The professional status of the user for the user type additional field. |
userDataTypeUserActive - AdditionalFieldUserDataTypeUserActiveType
|
The active status of the user for the user type additional field. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "xyz789",
"description": "abc123",
"dataTypeDisplayName": "abc123",
"fieldDataType": "integer",
"listDataType": AdditionalFieldListDataType,
"allowsSecondaryField": false,
"secondaryFieldName": "xyz789",
"allowsMultipleValues": false,
"booleanDataTypeTrueValue": "xyz789",
"booleanDataTypeFalseValue": "abc123",
"numericDataTypeMaxValue": 123.45,
"numericDataTypeMinValue": 987.65,
"decimalDataTypePrecision": 123,
"stringDataTypeMaxLength": 987,
"stringDataTypeMultiLine": false,
"userDataTypeUserProfessional": "Any",
"userDataTypeUserActive": "Active"
}
AdditionalFieldListDataType
Description
Represents a list of options for the list type additional field.
Fields
| Field Name | Description |
|---|---|
options - [AdditionalFieldListDataTypeOption]
|
The list of options for a list type field definition. |
Example
{"options": [AdditionalFieldListDataTypeOption]}
AdditionalFieldListDataTypeOption
AdditionalFieldUserDataTypeUserActiveType
Description
The active status of the additional field user data.
Values
| Enum Value | Description |
|---|---|
|
|
Active user. |
|
|
Inactive user. |
|
|
Not set. |
|
|
Unknown user. |
Example
"Active"
AdditionalFieldUserDataTypeUserType
Description
The user type of the additional field user data.
Values
| Enum Value | Description |
|---|---|
|
|
Any user type. |
|
|
Professional user type. |
|
|
Non-professional user type. |
|
|
Not set. |
|
|
Unknown user type. |
Example
"Any"
AdditionalFieldValue
Description
Represents a value for an additional field definition.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the field value. |
fieldId - ID
|
The ID of the field definition this value is associated with. |
listId - ID
|
The ID of the list the field definition is associated with. |
contactId - ID
|
The ID of the contact this field value is associated with. |
fieldDisplayName - String
|
The display name of the field. |
valueItems - [AdditionalFieldValueItem]
|
A list of additional field value items associated with this additional field definition for a contact. |
dataType - AdditionalFieldDataType
|
The data type of the field value. |
separator - String
|
The separator used in the field value. |
format - String
|
The format of the field value. |
Example
{
"id": "00000006-0002-0000-0000-000000000000|00000007-0002-0000-0000-000000000000",
"fieldId": "00000006-0002-0000-0000-000000000000",
"listId": "00000006-0002-0000-0000-000000000000",
"contactId": "00000006-0002-0000-0000-000000000000",
"fieldDisplayName": "abc123",
"valueItems": [AdditionalFieldValueItem],
"dataType": "integer",
"separator": "abc123",
"format": "abc123"
}
AdditionalFieldValueFilterInput
Description
Input for filtering additional field values.
Fields
| Input Field | Description |
|---|---|
definitionIds - [ID!]
|
The list of definition IDs to filter by. |
Example
{
"definitionIds": [
"00000006-0002-0000-0000-000000000000"
]
}
AdditionalFieldValueItem
Description
Represents a single value for an additional field.
Example
{
"valueId": "00000006-0002-0000-0000-000000000000",
"lastEditDate": "2007-12-03T10:15:30Z",
"value": "xyz789",
"qualification": "xyz789"
}
AdditionalFieldValueResults
Description
Represents the results of a query for additional field values.
Fields
| Field Name | Description |
|---|---|
totalModels - Int!
|
The total number of items found. |
models - [AdditionalFieldValue]
|
The list of AdditionalFieldValue objects. |
Example
{"totalModels": 987, "models": [AdditionalFieldValue]}
Address
Description
Represents an address.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the address. |
type - AddressTypes
|
The type of the address (Street, POBox, LockBox). |
usage - UsageTypes
|
The usage type of the address (AlternateBusiness, AlternateHome, etc.). |
label - String
|
The label of the address. |
street - String
|
The street name of the address. |
city - String
|
The city of the address (city, town, village, etc.). |
administrativeDivision - String
|
The administrative division of the address. This represents a state, province, governorate, department, or similar regional division depending on the country. This field may not be applicable for all countries. |
additional - String
|
Additional address information (not applicable to 'my' contact addresses). |
country - String
|
The country of the address. |
postalCode - String
|
The ZIP or postal code of the address. This field may not be applicable for all countries. |
isGlobal - Boolean
|
Indicates whether this is a global address. |
isMailingAddress - Boolean
|
Indicates whether this is a mailing address. |
owningContactId - ID
|
The ID of the contact that owns this address. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"type": "Street",
"usage": "AlternateBusiness",
"label": "abc123",
"street": "xyz789",
"city": "xyz789",
"administrativeDivision": "abc123",
"additional": "abc123",
"country": "xyz789",
"postalCode": "abc123",
"isGlobal": true,
"isMailingAddress": true,
"owningContactId": "00000006-0002-0000-0000-000000000000"
}
AddressInput
Description
Input for creating or updating an address.
Fields
| Input Field | Description |
|---|---|
addressId - ID
|
The ID of the address to update. Can be null for new values. |
owningContactId - ID
|
The ID of the contact that owns this address. |
isMailingAddress - Boolean
|
Indicates whether this is a mailing address. |
label - String
|
The label for this address. |
street - String
|
The street for this address. |
city - String
|
The city for this address (city, town, village, etc.). |
administrativeDivision - String
|
The administrative division for this address. This represents a state, province, governorate, department, or similar regional division depending on the country. This field may not be applicable for all countries. |
country - String
|
The country for this address. |
postalCode - String
|
The ZIP or postal code for this address. This field may not be applicable for all countries. |
additionalField - String
|
The additional information for this address. |
usage - UsageTypes
|
The usage type for this address. |
Example
{
"addressId": "00000006-0002-0000-0000-000000000000",
"owningContactId": "00000006-0002-0000-0000-000000000000",
"isMailingAddress": false,
"label": "abc123",
"street": "xyz789",
"city": "abc123",
"administrativeDivision": "abc123",
"country": "xyz789",
"postalCode": "xyz789",
"additionalField": "xyz789",
"usage": "AlternateBusiness"
}
AddressTypes
Description
The available address types.
Values
| Enum Value | Description |
|---|---|
|
|
Indicates that the address type is a street address. |
|
|
Indicates that the address type is a post office box. |
|
|
Indicates that the address type is a lock box. |
|
|
Indicates that the address type is other than the predefined types. |
Example
"Street"
AdministrativeDivision
Description
Represents a state, province, governorate, department, or similar regional division depending on the country.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "xyz789",
"abbreviation": "xyz789"
}
AdministrativeDivisions
Description
Represents a state, province, governorate, department, or similar regional division depending on the country.
Example
{
"states": [State],
"useStates": true,
"stateLabel": "xyz789",
"postalCodeLabel": "abc123"
}
BigInt
Example
{}
Boolean
Example
true
BusinessPlanningActivity
Description
Represents an activity associated with a business planning entity.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the activity. |
type - String
|
The type of the activity. |
subject - String
|
The subject of the activity. |
summary - String
|
The summary of the activity. |
originatorId - ID
|
The ID of the originator of the activity. |
originatorFirstName - String
|
The first name of the originator of the activity. |
originatorLastName - String
|
The last name of the originator of the activity. |
activityDate - DateTime
|
The date of the activity. |
entityId - ID
|
The ID of the business planning entity (initiative or objective) the activity is linked to. |
entityName - String
|
The name of the business planning entity (initiative or objective) the activity is linked to. |
editAllowed - Boolean
|
Indicates whether the current user is permitted to edit this activity. |
deleteAllowed - Boolean
|
Indicates whether the current user is permitted to delete this activity. |
activity - Activity
|
The activity linked to this business planning activity. |
canEdit - Boolean
|
Indicates whether the current user can edit the activity. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"type": "abc123",
"subject": "abc123",
"summary": "xyz789",
"originatorId": "00000006-0002-0000-0000-000000000000",
"originatorFirstName": "xyz789",
"originatorLastName": "xyz789",
"activityDate": "2007-12-03T10:15:30Z",
"entityId": "00000006-0002-0000-0000-000000000000",
"entityName": "xyz789",
"editAllowed": false,
"deleteAllowed": true,
"activity": Activity,
"canEdit": false
}
BusinessPlanningActivityFilter
Description
Input for filtering the activities.
Fields
| Input Field | Description |
|---|---|
activityTypeName - String
|
The activity type name to filter the activities by. |
originatorLastName - String
|
The originator last name to filter the activities by. |
summary - String
|
The summary to filter the activities by. |
subject - String
|
The subject to filter the activities by. |
date - DateFilterInput
|
The date range to filter the activities by. |
entityName - String
|
The entity name to filter the activities by. |
Example
{
"activityTypeName": "abc123",
"originatorLastName": "xyz789",
"summary": "abc123",
"subject": "xyz789",
"date": DateFilterInput,
"entityName": "xyz789"
}
BusinessPlanningActivitySort
Description
Input for sorting the activities.
Fields
| Input Field | Description |
|---|---|
field - BusinessPlanningSortField!
|
The field to sort the activities by. |
direction - SortDirection
|
The direction to sort the activities in. Default = Ascending |
Example
{"field": "activityDate", "direction": "Ascending"}
BusinessPlanningCompanyFilter
Description
Input for filtering the companies.
Example
{
"name": "xyz789",
"businessCity": "xyz789",
"businessState": "abc123"
}
BusinessPlanningCompanySort
Description
Input for sorting the companies.
Fields
| Input Field | Description |
|---|---|
field - BusinessPlanningCompanySortField!
|
The field to sort the companies by. |
direction - SortDirection
|
The direction to sort the companies in. Default = Ascending |
Example
{"field": "name", "direction": "Ascending"}
BusinessPlanningCompanySortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"name"
BusinessPlanningConnection
Description
Represents a relationship connection between two contacts.
Fields
| Field Name | Description |
|---|---|
relationshipId - ID
|
The ID of the relationship. |
relationshipTypeId - Int
|
The ID of the relationship type. |
linkedUser - BusinessPlanningPerson
|
The linked user of the relationship. |
targetContact - BusinessPlanningPerson
|
The target contact of the relationship. |
relationshipScore - Score
|
The relationship score of the connection. |
Example
{
"relationshipId": "00000006-0002-0000-0000-000000000000",
"relationshipTypeId": 123,
"linkedUser": BusinessPlanningPerson,
"targetContact": BusinessPlanningPerson,
"relationshipScore": Score
}
BusinessPlanningConnectionResults
Fields
| Field Name | Description |
|---|---|
skip - Int
|
The starting index for pagination. |
limit - Int
|
The maximum number of items to retrieve. |
sort - Sort
|
The sorting options applied to the results. |
totalModels - Int!
|
The total number of items found. |
models - [BusinessPlanningConnection]
|
The list of company employee relationships. |
Example
{
"skip": 987,
"limit": 987,
"sort": Sort,
"totalModels": 987,
"models": [BusinessPlanningConnection]
}
BusinessPlanningInitiativeCompany
Description
Represents a company associated with an initiative.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the company contact. |
name - String
|
The name of the company. |
company - Company
|
The company associated with the initiative. |
initiativeId - ID
|
The ID of the initiative the company is associated with. |
initiativeName - String
|
The name of the initiative the company is associated with. |
businessCity - String
|
The business city of the company. |
businessState - String
|
The business state of the company. |
contactTypes - [ContactFolderContactType]
|
The list of contact types associated with the company. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"company": Company,
"initiativeId": "00000006-0002-0000-0000-000000000000",
"initiativeName": "xyz789",
"businessCity": "abc123",
"businessState": "xyz789",
"contactTypes": [ContactFolderContactType]
}
BusinessPlanningInitiativeCompanyFilter
Description
Input for filtering the initiative companies.
Fields
| Input Field | Description |
|---|---|
name - String
|
The company name to filter the initiative companies by. |
initiativeName - String
|
The initiative name to filter the initiative companies by. |
businessCity - String
|
The business city to filter the initiative companies by. |
businessState - String
|
The business state to filter the initiative companies by. |
Example
{
"name": "xyz789",
"initiativeName": "xyz789",
"businessCity": "xyz789",
"businessState": "xyz789"
}
BusinessPlanningInitiativeCompanyResults
Description
Represents the results of a query for the initiative companies associated with an objective.
Fields
| Field Name | Description |
|---|---|
skip - Int
|
The starting index for pagination. |
limit - Int
|
The maximum number of items to retrieve. |
sort - Sort
|
The sorting options applied to the results. |
totalModels - Int!
|
The total number of items found. |
models - [BusinessPlanningInitiativeCompany]
|
The list of initiative companies. |
Example
{
"skip": 987,
"limit": 123,
"sort": Sort,
"totalModels": 987,
"models": [BusinessPlanningInitiativeCompany]
}
BusinessPlanningInitiativeCompanySort
Description
Input for sorting the initiative companies.
Fields
| Input Field | Description |
|---|---|
field - BusinessPlanningInitiativeCompanySortField!
|
The field to sort the initiative companies by. |
direction - SortDirection
|
The direction to sort the initiative companies in. Default = Ascending |
Example
{"field": "initiativeName", "direction": "Ascending"}
BusinessPlanningInitiativeCompanySortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"initiativeName"
BusinessPlanningLocation
Description
Represents a location associated with a business planning entity.
Fields
| Field Name | Description |
|---|---|
country - Country
|
The country of the location. |
administrativeDivision - AdministrativeDivision
|
The administrative division of the location. |
Example
{
"country": Country,
"administrativeDivision": AdministrativeDivision
}
BusinessPlanningMeasurementOfSuccess
Description
Represents a measurement of success for a business planning entity.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the measurement of success. |
description - String
|
The description of the measurement of success. |
measurementType - MeasurementType
|
The measurement type of the measurement of success. |
currencyType - String
|
The currency type of the measurement of success. |
targetValue - Decimal
|
The target value of the measurement of success. |
actualValue - Decimal
|
The actual value of the measurement of success. |
numberType - NumberType
|
The number type of the measurement of success. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"description": "abc123",
"measurementType": "currency",
"currencyType": "xyz789",
"targetValue": Decimal,
"actualValue": Decimal,
"numberType": "wholeNumber"
}
BusinessPlanningObjectiveCompany
Description
Represents a company associated with an objective.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the contact. |
name - String
|
The name of the company. |
businessCity - String
|
The business city of the company. |
businessState - String
|
The business state of the company. |
contactTypes - [ContactFolderContactType]
|
The list of contact types associated with this company. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "xyz789",
"businessCity": "xyz789",
"businessState": "xyz789",
"contactTypes": [ContactFolderContactType]
}
BusinessPlanningObjectiveCompanyResults
Description
Represents the results of a query for the companies associated with an objective.
Fields
| Field Name | Description |
|---|---|
skip - Int
|
The starting index for pagination. |
limit - Int
|
The maximum number of items to retrieve. |
sort - Sort
|
The sorting options applied to the results. |
totalModels - Int!
|
The total number of items found. |
models - [BusinessPlanningObjectiveCompany]
|
The list of companies. |
Example
{
"skip": 987,
"limit": 123,
"sort": Sort,
"totalModels": 987,
"models": [BusinessPlanningObjectiveCompany]
}
BusinessPlanningPerson
Description
Represents a person associated with an initiative.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the contact. |
firstName - String
|
The first name of the person. |
lastName - String
|
The last name of the person. |
jobTitle - String
|
The job title of the person. |
companyName - String
|
The company name of the person. |
hasRelationship - Boolean
|
Indicates whether the person has a relationship. |
person - Person
|
The person contact. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"firstName": "xyz789",
"lastName": "abc123",
"jobTitle": "abc123",
"companyName": "abc123",
"hasRelationship": true,
"person": Person
}
BusinessPlanningSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"activityDate"
BusinessPlanningTag
Description
Represents a tag associated with a business planning entity.
Fields
| Field Name | Description |
|---|---|
type - BusinessPlanningTagType
|
The type of the tag. |
displayName - String
|
The display name of the tag. |
Example
{
"type": "industry",
"displayName": "xyz789"
}
BusinessPlanningTagType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"industry"
BusinessPlanningTypes
Description
Represents the types associated with a business planning entity.
Fields
| Field Name | Description |
|---|---|
industries - [Industry]
|
The list of industries associated with the entity. |
practiceGroups - [PracticeGroup]
|
The list of practice groups associated with the entity. |
otherTypes - [String]
|
The list of other types associated with the entity. |
keyClient - Boolean
|
Indicates whether the entity is a key client. |
Example
{
"industries": [Industry],
"practiceGroups": [PracticeGroup],
"otherTypes": ["xyz789"],
"keyClient": false
}
Company
Description
Represents a company contact.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the company. |
displayName - String
|
The display name of the company. |
contactEntity - ContactEntity
|
The entity type of the contact (Company). |
visibility - ContactVisibility
|
The visibility settings of the company. |
notes - Notes
|
The firm notes and 'my' notes about the company. |
name - String
|
The name of the company. |
alias - String
|
The common name or alias of the company. |
relationshipScore - Score
|
The relationship score between the current user and the specified company contact. |
isPendingFirmContact - Boolean!
|
Indicates whether this company is pending to be linked as My Contact and Firm Contact. |
addresses - [Address]
|
Retrieves the addresses associated to the company. |
Arguments
|
|
tags - [String]
|
The tags of the company. |
contactTypes - [ContactFolderContactType]
|
The contact types of the company. |
emailAddresses - [EmailAddress]
|
Retrieves the email addresses associated to the company. |
Arguments
|
|
phoneNumbers - [PhoneNumber]
|
Retrieves the phone numbers associated to the company. |
Arguments
|
|
additionalFieldValues - AdditionalFieldValueResults
|
Retrieves the list-specific additional field values for the company. |
Arguments
|
|
contactAdditionalFieldValues - ContactAdditionalFieldValueResults
|
Retrieves the additional field values associated with the company. |
Arguments
|
|
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "xyz789",
"contactEntity": "Any",
"visibility": "unknown",
"notes": Notes,
"name": "xyz789",
"alias": "xyz789",
"relationshipScore": Score,
"isPendingFirmContact": true,
"addresses": [Address],
"tags": ["xyz789"],
"contactTypes": [ContactFolderContactType],
"emailAddresses": [EmailAddress],
"phoneNumbers": [PhoneNumber],
"additionalFieldValues": AdditionalFieldValueResults,
"contactAdditionalFieldValues": ContactAdditionalFieldValueResults
}
CompanyEmployeeFilterInput
Description
Input for filtering the company employees.
Fields
| Input Field | Description |
|---|---|
name - String
|
The name to filter the company employees by. |
jobTitle - String
|
The job title to filter the company employees by. |
companyName - String
|
The company name to filter the company employees by. |
office - String
|
The office to filter the company employees by. |
email - String
|
The email to filter the company employees by. |
hasRelationship - Boolean
|
Whether to filter the company employees by whether they have a relationship. |
Example
{
"name": "xyz789",
"jobTitle": "abc123",
"companyName": "xyz789",
"office": "xyz789",
"email": "abc123",
"hasRelationship": false
}
CompanyEmployeeRelationshipFilter
Description
Input for filtering the company employee relationships.
Fields
| Input Field | Description |
|---|---|
leadFirstName - String
|
The first name of the lead contact for the company employee relationship. |
leadLastName - String
|
The last name of the lead contact for the company employee relationship. |
targetCompanyName - String
|
The company name of the target contact for the company employee relationship. |
targetFirstName - String
|
The first name of the target contact for the company employee relationship. |
targetLastName - String
|
The last name of the target contact for the company employee relationship. |
targetJobTitle - String
|
The job title of the target contact for the company employee relationship. |
Example
{
"leadFirstName": "abc123",
"leadLastName": "abc123",
"targetCompanyName": "abc123",
"targetFirstName": "abc123",
"targetLastName": "xyz789",
"targetJobTitle": "xyz789"
}
CompanyEmployeeRelationshipSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"leadFirstName"
CompanyEmployeeRelationshipSortInput
Description
Input for sorting the company employee relationships.
Fields
| Input Field | Description |
|---|---|
field - CompanyEmployeeRelationshipSortField!
|
The field to sort the company employee relationships by. |
direction - SortDirection
|
The direction to sort the company employee relationships in. Default = Ascending |
Example
{"field": "leadFirstName", "direction": "Ascending"}
CompanyEmployeeResults
Fields
| Field Name | Description |
|---|---|
skip - Int
|
The starting index for pagination. |
limit - Int
|
The maximum number of items to retrieve. |
sort - Sort
|
The sorting options applied to the results. |
totalModels - Int!
|
The total number of items found. |
models - [BusinessPlanningPerson]
|
The list of company employees. |
Example
{
"skip": 123,
"limit": 123,
"sort": Sort,
"totalModels": 987,
"models": [BusinessPlanningPerson]
}
CompanyEmployeeSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"companyName"
CompanyEmployeeSortInput
Description
Input for sorting the company employees.
Fields
| Input Field | Description |
|---|---|
field - CompanyEmployeeSortField!
|
The field to sort the company employees by. |
direction - SortDirection
|
The direction to sort the company employees in. Default = Ascending |
Example
{"field": "companyName", "direction": "Ascending"}
Contact
Description
Represents a contact.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the contact. |
displayName - String
|
The display name of the contact. |
contactEntity - ContactEntity
|
The entity type of the contact. |
visibility - ContactVisibility
|
The visibility settings of the contact. |
relationshipScore - Score
|
The relationship score between the current user and the contact. |
tags - [String]
|
The tags associated with the contact. |
contactTypes - [ContactFolderContactType]
|
The contact types associated with the contact. |
addresses - [Address]
|
Retrieves the addresses associated with the contact. |
Arguments
|
|
emailAddresses - [EmailAddress]
|
Retrieves the email addresses associated with the contact. |
Arguments
|
|
phoneNumbers - [PhoneNumber]
|
Retrieves the phone numbers associated with the contact. |
Arguments
|
|
notes - Notes
|
The firm notes and 'my' notes about the contact. |
additionalFieldValues - AdditionalFieldValueResults
|
Retrieves the list-specific additional field values for the contact. |
Arguments
|
|
contactAdditionalFieldValues - ContactAdditionalFieldValueResults
|
Retrieves the additional field values associated with the contact. |
Arguments
|
|
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "xyz789",
"contactEntity": "Any",
"visibility": "unknown",
"relationshipScore": Score,
"tags": ["xyz789"],
"contactTypes": [ContactFolderContactType],
"addresses": [Address],
"emailAddresses": [EmailAddress],
"phoneNumbers": [PhoneNumber],
"notes": Notes,
"additionalFieldValues": AdditionalFieldValueResults,
"contactAdditionalFieldValues": ContactAdditionalFieldValueResults
}
ContactAdditionalFieldValue
Description
Represents an additional field for a contact.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the additional field value. |
values - [ContactCustomFieldValue]
|
The list of additional field values. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"values": [ContactCustomFieldValue]
}
ContactAdditionalFieldValueResults
Fields
| Field Name | Description |
|---|---|
totalModels - Int!
|
The total number of items found. |
models - [ContactAdditionalFieldValue]
|
The list of additional field values. |
Example
{
"totalModels": 987,
"models": [ContactAdditionalFieldValue]
}
ContactCustomFieldValue
Fields
| Field Name | Description |
|---|---|
editAllowed - Boolean
|
Indicates whether editing is allowed for this additional field value. |
value - String
|
The value of the additional field. |
valueId - ID
|
The ID of the additional field value. |
lastEditDate - DateTime
|
The date and time when this field was last updated. |
qualificationDescription - String
|
The qualification or secondary value for the additional field. |
Example
{
"editAllowed": false,
"value": "abc123",
"valueId": "00000006-0002-0000-0000-000000000000",
"lastEditDate": "2007-12-03T10:15:30Z",
"qualificationDescription": "xyz789"
}
ContactEntity
Description
The available contact entity types.
Values
| Enum Value | Description |
|---|---|
|
|
Indicates that the contact entity can be either Person or Company. |
|
|
Indicates that the contact entity is not specified. |
|
|
Indicates that the contact entity is a person. |
|
|
Indicates that the contact entity is a company. |
Example
"Any"
ContactFilterField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"companyName"
ContactFilterInput
Fields
| Input Field | Description |
|---|---|
field - ContactFilterField
|
Specifies the field type to filter contacts (ID, Company Name, Job Title, etc.). |
value - String
|
Specifies the value to filter contacts by the selected field. |
values - [String]
|
Specifies multiple values to filter contacts by the selected field. |
Example
{
"field": "companyName",
"value": "abc123",
"values": ["xyz789"]
}
ContactFolderContactType
ContactResults
Fields
| Field Name | Description |
|---|---|
searchTerms - SearchTerms
|
The contact search query term. |
resultsFrom - SearchResultsFrom
|
The contact results found based on the search criterion (Term, Email Address, Full Name). |
totalModels - Int!
|
The total number of items found. |
models - [Contact]
|
The list of contacts. |
Example
{
"searchTerms": SearchTerms,
"resultsFrom": "Term",
"totalModels": 123,
"models": [Contact]
}
ContactType
Description
Represents a contact type.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the contact type. |
name - String
|
The display name of the contact type. |
pluralName - String
|
The plural form of the contact type name. |
folderId - ID
|
The ID of the contact type folder. |
folderType - String
|
The type of folder (Client, Organizations, etc.). |
allowedContactEntity - ContactEntity
|
The allowed contact entity type (Person, Company or Any). |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "xyz789",
"pluralName": "xyz789",
"folderId": "00000006-0002-0000-0000-000000000000",
"folderType": "xyz789",
"allowedContactEntity": "Any"
}
ContactTypeResults
Fields
| Field Name | Description |
|---|---|
totalModels - Int!
|
The total number of items found. |
models - [ContactType]
|
The list of contact types. |
Example
{"totalModels": 987, "models": [ContactType]}
ContactVisibility
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"unknown"
Country
Description
Represents a country.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the country. |
name - String
|
The name of the country. |
isoCode - String
|
The ISO code of the country. |
statusIndicator - Int
|
The state indicator of the country. Controls the behavior of the state/province field: 0: The state/province field is not used for this country. 1: The state/province field is optional for this country. 2: The state/province field is required for this country. |
administrativeDivisions - AdministrativeDivisions
|
The administrative divisions of the country. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"isoCode": "abc123",
"statusIndicator": 987,
"administrativeDivisions": AdministrativeDivisions
}
CountryFilter
Fields
| Input Field | Description |
|---|---|
name - String
|
Filters countries based on their name. |
Example
{"name": "xyz789"}
CountryResults
CurrencyCustomField
Description
Represents a custom field that stores a currency value.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the currency custom field. |
displayName - String
|
The display name of the currency custom field. |
description - String
|
The description of the currency custom field. |
required - Boolean
|
Indicates whether the currency custom field is required. |
isActive - Boolean
|
Indicates whether the currency custom field is active. |
canRemove - Boolean
|
Indicates whether the currency custom field can be removed. |
control - CustomFieldControl
|
The control for the currency custom field. |
createDate - Date
|
The date the currency custom field was created. |
changeDate - Date
|
The date the currency custom field was last changed. |
displayOrder - Int
|
The display order of the currency custom field. |
currencyMaxAmount - Decimal
|
The maximum currency amount for the field. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "abc123",
"description": "abc123",
"required": true,
"isActive": false,
"canRemove": false,
"control": CustomFieldControl,
"createDate": "2007-12-03",
"changeDate": "2007-12-03",
"displayOrder": 123,
"currencyMaxAmount": Decimal
}
CustomField
Description
Represents a custom field.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the custom field. |
displayName - String
|
The display name of the custom field. |
description - String
|
The description of the custom field. |
required - Boolean
|
Indicates whether the custom field is required. |
isActive - Boolean
|
Indicates whether the custom field is active. |
canRemove - Boolean
|
Indicates whether the custom field can be removed. |
control - CustomFieldControl
|
The control for the custom field. |
createDate - Date
|
The date the custom field was created. |
changeDate - Date
|
The date the custom field was last changed. |
displayOrder - Int
|
The display order of the custom field. |
Possible Types
| CustomField Types |
|---|
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "xyz789",
"description": "abc123",
"required": true,
"isActive": true,
"canRemove": false,
"control": CustomFieldControl,
"createDate": "2007-12-03",
"changeDate": "2007-12-03",
"displayOrder": 123
}
CustomFieldBooleanData
CustomFieldCompanyData
Description
Represents the company data value of a custom field.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"companyName": "abc123",
"contactId": "00000006-0002-0000-0000-000000000000"
}
CustomFieldControl
Description
Represents the control configuration of a custom field.
Fields
| Field Name | Description |
|---|---|
controlType - CustomFieldControlType!
|
The type of control for the custom field. |
dataType - CustomFieldDatatype!
|
The datatype of the custom field. |
controlDisplayName - String!
|
The display name of the control. |
Example
{
"controlType": "TextArea",
"dataType": "None",
"controlDisplayName": "abc123"
}
CustomFieldControlType
Description
The available custom field control type options.
Values
| Enum Value | Description |
|---|---|
|
|
Indicates that the control type is a text area. |
|
|
Indicates that the control type is a text box. |
|
|
Indicates that the control type is a date picker. |
|
|
Indicates that the control type is an integer input. |
|
|
Indicates that the control type is a single-select list. |
|
|
Indicates that the control type is a multi-select list. |
|
|
Indicates that the control type is a currency input. |
|
|
Indicates that the control type is a person contact input. |
|
|
Indicates that the control type is a company contact input. |
|
|
Indicates that the control type is a hyperlink. |
|
|
Indicates that the control type is a boolean radio button. |
|
|
Indicates that the control type is a single-select user picklist. |
|
|
Indicates that the control type is a multi-select user picklist. |
Example
"TextArea"
CustomFieldCurrencyData
Description
Represents the currency data value of a custom field.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"value": Decimal,
"currencyIsoCode": "xyz789"
}
CustomFieldData
Description
Represents the data value of a custom field.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the custom field data. |
Example
{
"id": "00000006-0002-0000-0000-000000000000"
}
CustomFieldDatatype
Description
The available custom field datatype options.
Values
| Enum Value | Description |
|---|---|
|
|
Indicates that the datatype is none. |
|
|
Indicates that the datatype is boolean. |
|
|
Indicates that the datatype is string. |
|
|
Indicates that the datatype is date. |
|
|
Indicates that the datatype is integer. |
|
|
Indicates that the datatype is enum. |
|
|
Indicates that the datatype is currency. |
|
|
Indicates that the datatype is a company contact. |
|
|
Indicates that the datatype is a person contact. |
|
|
Indicates that the datatype is a hyperlink. |
|
|
Indicates that the datatype is boolean. |
Example
"None"
CustomFieldDateData
CustomFieldEntityType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"opportunity"
CustomFieldEnumData
Description
Represents the enum data value of a custom field.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"enumId": "00000006-0002-0000-0000-000000000000",
"value": "abc123"
}
CustomFieldEnumInput
Description
Represents the enum configuration for a custom field.
Fields
| Input Field | Description |
|---|---|
options - [CustomFieldEnumOptionInput]!
|
The list of options for the enum field. |
Example
{"options": [CustomFieldEnumOptionInput]}
CustomFieldEnumOption
Description
Represents an option available for an enum custom field.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"isActive": true
}
CustomFieldEnumOptionInput
Description
Represents an option for an enum custom field.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"isActive": false
}
CustomFieldFilter
Description
Represents the filter criteria for custom fields.
Fields
| Input Field | Description |
|---|---|
customFieldId - ID
|
The ID to filter custom fields by. |
displayName - String
|
The display name to filter custom fields by. |
controlDisplayName - String
|
The control display name to filter custom fields by. |
required - Boolean
|
The required status to filter custom fields by. |
isActive - Boolean
|
The active status to filter custom fields by. |
createDate - DateFilterInput
|
The create date to filter custom fields by. |
changeDate - DateFilterInput
|
The change date to filter custom fields by. |
Example
{
"customFieldId": "00000006-0002-0000-0000-000000000000",
"displayName": "abc123",
"controlDisplayName": "xyz789",
"required": true,
"isActive": false,
"createDate": DateFilterInput,
"changeDate": DateFilterInput
}
CustomFieldHyperlinkData
CustomFieldIntegerData
CustomFieldPersonData
Description
Represents the person data value of a custom field.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the person custom field data. |
firstName - String
|
The first name of the person. |
lastName - String
|
The last name of the person. |
jobTitle - String
|
The job title of the person. |
companyName - String
|
The company name of the person. |
contactId - ID
|
The ID of the contact for the person. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"firstName": "abc123",
"lastName": "abc123",
"jobTitle": "abc123",
"companyName": "xyz789",
"contactId": "00000006-0002-0000-0000-000000000000"
}
CustomFieldResults
Description
Represents the results of a query for custom fields.
Fields
| Field Name | Description |
|---|---|
skip - Int
|
The starting index for pagination. |
limit - Int
|
The maximum number of items to retrieve. |
sort - Sort
|
The sorting options for the custom fields. |
totalModels - Int!
|
The total number of items found. |
models - [CustomField]
|
The list of custom fields. |
Example
{
"skip": 987,
"limit": 987,
"sort": Sort,
"totalModels": 987,
"models": [CustomField]
}
CustomFieldSort
Description
Represents the sorting options for custom fields.
Fields
| Input Field | Description |
|---|---|
field - CustomFieldSortField!
|
The field to sort custom fields by. |
direction - SortDirection
|
The sort direction for the custom fields. Default = Ascending |
Example
{"field": "displayName", "direction": "Ascending"}
CustomFieldSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"displayName"
CustomFieldStringData
CustomFieldValue
Description
Represents the value of a custom field.
Fields
| Field Name | Description |
|---|---|
customField - CustomField
|
The custom field the value belongs to. |
values - [CustomFieldData]
|
The list of data values for the custom field. |
Example
{
"customField": CustomField,
"values": [CustomFieldData]
}
CustomFieldValueCurrencyInput
Description
Represents currency information for a custom field value.
Fields
| Input Field | Description |
|---|---|
currencyIsoCode - String
|
The ISO code of the currency. |
Example
{"currencyIsoCode": "xyz789"}
CustomFieldValueFilter
Description
Represents the filter criteria for custom field values.
Fields
| Input Field | Description |
|---|---|
displayName - String
|
The display name to filter custom field values by. |
controlDisplayName - String
|
The control display name to filter custom field values by. |
required - Boolean
|
The required status to filter custom field values by. |
isActive - Boolean
|
The active status to filter custom field values by. |
Example
{
"displayName": "abc123",
"controlDisplayName": "abc123",
"required": true,
"isActive": true
}
CustomFieldValueInput
Description
Represents the value to set for a custom field.
Fields
| Input Field | Description |
|---|---|
fieldId - ID!
|
The ID of the field. |
valueId - ID
|
The ID of the value, if present. |
value - String
|
The value of the field. |
currencyInfo - CustomFieldValueCurrencyInput
|
The currency information for the value. |
dataType - CustomFieldDatatype!
|
The datatype for the field. |
Example
{
"fieldId": "00000006-0002-0000-0000-000000000000",
"valueId": "00000006-0002-0000-0000-000000000000",
"value": "xyz789",
"currencyInfo": CustomFieldValueCurrencyInput,
"dataType": "None"
}
CustomForm
Description
Represents a custom form.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the custom form. |
name - String
|
The name of the custom form. |
description - String
|
The description of the custom form. |
entityType - CustomFieldEntityType
|
The entity type the custom form applies to. |
isActive - Boolean
|
Indicates whether the custom form is active. |
canRemove - Boolean
|
Indicates whether the custom form can be removed. |
customFields - CustomFieldResults
|
Retrieves the list of custom fields for the custom form. |
Arguments
|
|
customFieldValues - [CustomFieldValue]
|
Retrieves the custom field values for an entity. |
Arguments
|
|
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "xyz789",
"description": "xyz789",
"entityType": "opportunity",
"isActive": false,
"canRemove": true,
"customFields": CustomFieldResults,
"customFieldValues": [CustomFieldValue]
}
CustomFormFilterInput
Description
Represents the filter criteria for custom forms.
Fields
| Input Field | Description |
|---|---|
isActive - Boolean
|
The active status to filter custom forms by. |
entityType - CustomFieldEntityType
|
The entity type to filter custom forms by. |
Example
{"isActive": true, "entityType": "opportunity"}
CustomFormResults
Description
Represents the results of a query for custom forms.
Fields
| Field Name | Description |
|---|---|
skip - Int
|
The starting index for pagination. |
limit - Int
|
The maximum number of items to retrieve. |
sort - Sort
|
The sorting options for the custom forms. |
totalModels - Int!
|
The total number of items found. |
models - [CustomForm]
|
The list of custom forms. |
Example
{
"skip": 123,
"limit": 987,
"sort": Sort,
"totalModels": 987,
"models": [CustomForm]
}
CustomFormSort
Description
Represents the sorting options for custom forms.
Fields
| Input Field | Description |
|---|---|
field - CustomFormSortField!
|
The field to sort custom forms by. |
direction - SortDirection
|
The sort direction for the custom forms. Default = Ascending |
Example
{"field": "createDate", "direction": "Ascending"}
CustomFormSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"createDate"
Date
Description
The Date scalar type represents a year, month and day in accordance with the ISO-8601 standard.
Example
"2007-12-03"
DateFilterInput
DateTime
Description
The DateTime scalar type represents a date and time. DateTime expects timestamps to be formatted in accordance with the ISO-8601 standard.
Example
"2007-12-03T10:15:30Z"
DateTimeOffset
Description
The DateTimeOffset scalar type represents a date, time and offset from UTC. DateTimeOffset expects timestamps to be formatted in accordance with the ISO-8601 standard.
Example
DateTimeOffset
DateTimeOffsetFilterInput
Fields
| Input Field | Description |
|---|---|
start - DateTimeOffset
|
Specifies the start date of the date range, including timezone information. |
end - DateTimeOffset
|
Specifies the end date of the date range, including timezone information. |
Example
{
"start": DateTimeOffset,
"end": DateTimeOffset
}
Decimal
Example
Decimal
EditPersonEmploymentInformationInput
Description
Input for updating a person's employment information.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the person. |
companyId - ID
|
The ID of the company to associate with the person. |
companyName - String
|
The name of the company to associate with the person. |
employmentInfoChange - EmploymentInfoChange!
|
The status type for the employment change for the person. |
jobTitle - String
|
The job title for the person. |
department - String
|
The department for the person. |
businessAddress - EmploymentChangeAddressInput
|
The business address information. |
businessPhoneNumber - EmploymentChangePhoneInput
|
The primary business phone number. |
business2PhoneNumber - EmploymentChangePhoneInput
|
The secondary business phone number. |
mobilePhoneNumber - EmploymentChangePhoneInput
|
The mobile phone number. |
businessFaxNumber - EmploymentChangePhoneInput
|
The business fax number. |
pagerNumber - EmploymentChangePhoneInput
|
The pager number. |
businessElectronicAddress - EmploymentChangeElectronicAddressInput
|
The business email address. |
businessWebsite - EmploymentChangeElectronicAddressInput
|
The business website. |
assistantName - String
|
The name of the person's assistant. |
assistantPhoneNumber - EmploymentChangePhoneInput
|
The phone number of the person's assistant. |
formerEmploymentDetails - String
|
The details about the person's former employment. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"companyId": "00000006-0002-0000-0000-000000000000",
"companyName": "abc123",
"employmentInfoChange": "EmployerNotKnown",
"jobTitle": "abc123",
"department": "xyz789",
"businessAddress": EmploymentChangeAddressInput,
"businessPhoneNumber": EmploymentChangePhoneInput,
"business2PhoneNumber": EmploymentChangePhoneInput,
"mobilePhoneNumber": EmploymentChangePhoneInput,
"businessFaxNumber": EmploymentChangePhoneInput,
"pagerNumber": EmploymentChangePhoneInput,
"businessElectronicAddress": EmploymentChangeElectronicAddressInput,
"businessWebsite": EmploymentChangeElectronicAddressInput,
"assistantName": "xyz789",
"assistantPhoneNumber": EmploymentChangePhoneInput,
"formerEmploymentDetails": "xyz789"
}
ElectronicAddressInput
Description
Input for creating or updating an electronic address (email, website, etc.).
Fields
| Input Field | Description |
|---|---|
id - ID
|
The ID of the electronic address to update. Can be null for new values. |
owningContactId - ID
|
The ID of the contact that owns this electronic address. |
electronicAddress - String
|
The electronic address. |
usage - UsageTypes
|
The usage type for this electronic address. |
electronicAddressType - EmailAddressTypes
|
The type for this electronic address. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"owningContactId": "00000006-0002-0000-0000-000000000000",
"electronicAddress": "xyz789",
"usage": "AlternateBusiness",
"electronicAddressType": "Email"
}
EmailAddress
Description
Represents an email address associated with a contact.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the email address. |
type - EmailAddressTypes
|
The type of the email address (Email, FTPSite, Website). |
usage - UsageTypes
|
The usage type of the email address (AlternateBusiness, AlternateHome, etc.). |
address - String
|
The email address. |
label - String
|
The label of the email address. |
owningContactId - ID
|
The ID of the contact that owns this email address. |
isGlobal - Boolean
|
Indicates whether this is a global email address. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"type": "Email",
"usage": "AlternateBusiness",
"address": "abc123",
"label": "xyz789",
"owningContactId": "00000006-0002-0000-0000-000000000000",
"isGlobal": false
}
EmailAddressTypes
Description
The available email address types.
Values
| Enum Value | Description |
|---|---|
|
|
Indicates that the email address type is a standard email. |
|
|
Indicates that the email address type is an FTP site. |
|
|
Indicates that the email address type is a website. |
|
|
Indicates that the email address type is other than the predefined types. |
|
|
Indicates that the email address type is a LinkedIn profile URL. Use enumeration WebSite instead. |
|
|
Indicates that the email address type is an Instagram profile URL. Use enumeration WebSite instead. |
|
|
Indicates that the email address type is a Facebook profile URL. Use enumeration WebSite instead. |
|
|
Indicates that the email address type is a X (formerly Twitter) profile URL. Use enumeration WebSite instead. |
Example
"Email"
EmploymentChangeAddressInput
Description
Input for updating an address as part of an employment change.
Fields
| Input Field | Description |
|---|---|
addressId - ID
|
The ID of the address. |
label - String
|
The label for the address. |
street - String
|
The street for the address. |
city - String
|
The city for the address (city, town, village, etc.). |
administrativeDivision - String
|
The administrative division for the address. This represents a state, province, governorate, department, or similar regional division depending on the country. This field may not be applicable for all countries. |
country - String
|
The country for the address. |
postalCode - String
|
The ZIP or postal code for the address. This field may not be applicable for all countries. |
additionalField - String
|
Additional information for the address. Only applicable for business addresses. |
isGlobalMailingAddress - Boolean
|
Indicates whether this address is considered a global mailing address. |
owningContactId - ID
|
The ID of the contact that owns this address. |
Example
{
"addressId": "00000006-0002-0000-0000-000000000000",
"label": "xyz789",
"street": "xyz789",
"city": "xyz789",
"administrativeDivision": "abc123",
"country": "abc123",
"postalCode": "xyz789",
"additionalField": "abc123",
"isGlobalMailingAddress": true,
"owningContactId": "00000006-0002-0000-0000-000000000000"
}
EmploymentChangeElectronicAddressInput
Description
Input for updating an electronic address as part of an employment change.
Example
{
"owningContactId": "00000006-0002-0000-0000-000000000000",
"electronicAddress": "abc123"
}
EmploymentChangePhoneInput
Description
Input for updating a phone number as part of an employment change.
Example
{
"owningContactId": "00000006-0002-0000-0000-000000000000",
"number": "abc123"
}
EmploymentInfoChange
Description
Specifies how to update a person's employment association:
- EmployerNotKnown: Removes any company association (both companyId and companyName should be null)
- NewCompany: Associates with a new company not yet in the system (provide companyName, leave companyId null)
- ExistingCompany: Associates with a company already in the system (provide both companyId and companyName)
Values
| Enum Value | Description |
|---|---|
|
|
Removes any company association for this person. |
|
|
Associates this person with a new company. |
|
|
Associates this person with an existing company. |
Example
"EmployerNotKnown"
EnumCustomField
Description
Represents a custom field that stores a value selected from a list of options.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the enum custom field. |
displayName - String
|
The display name of the enum custom field. |
description - String
|
The description of the enum custom field. |
required - Boolean
|
Indicates whether the enum custom field is required. |
isActive - Boolean
|
Indicates whether the enum custom field is active. |
canRemove - Boolean
|
Indicates whether the enum custom field can be removed. |
control - CustomFieldControl
|
The control for the enum custom field. |
createDate - Date
|
The date the enum custom field was created. |
changeDate - Date
|
The date the enum custom field was last changed. |
displayOrder - Int
|
The display order of the enum custom field. |
enumOptions - [CustomFieldEnumOption]
|
The list of enum options for the field. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "abc123",
"description": "abc123",
"required": true,
"isActive": false,
"canRemove": false,
"control": CustomFieldControl,
"createDate": "2007-12-03",
"changeDate": "2007-12-03",
"displayOrder": 987,
"enumOptions": [CustomFieldEnumOption]
}
FieldType
Description
Represents a field type for a profile.
Values
| Enum Value | Description |
|---|---|
|
|
Represents a section heading. |
|
|
Represents a static label. |
|
|
Represents a custom field. |
|
|
Represents a clickable URL. |
|
|
Represents a section separator. |
|
|
Represents a long text field. |
Example
"Heading"
Firm
Fields
| Field Name | Description |
|---|---|
settings - FirmSettings
|
The settings for the firm. |
Example
{"settings": FirmSettings}
FirmContactAddressEventView
Description
Represents an address event that occurred on a firm contact.
Fields
| Field Name | Description |
|---|---|
eventType - FirmContactEventViewType!
|
The type of event that occurred on the firm contact. |
eventDate - DateTimeOffset!
|
The date and time when the event occurred. |
contactId - ID!
|
The ID of the firm contact this event occurred on. |
contact - Contact
|
The firm contact this event occurred on. |
addressId - ID!
|
The ID of the address this event occurred on. |
Example
{
"eventType": "CompanyAddressAdded",
"eventDate": DateTimeOffset,
"contactId": "00000006-0002-0000-0000-000000000000",
"contact": Contact,
"addressId": "00000006-0002-0000-0000-000000000000"
}
FirmContactElectronicAddressEventView
Description
Represents an electronic address event that occurred on a firm contact.
Fields
| Field Name | Description |
|---|---|
eventType - FirmContactEventViewType!
|
The type of event that occurred on the firm contact. |
eventDate - DateTimeOffset!
|
The date and time when the event occurred. |
contactId - ID!
|
The ID of the firm contact this event occurred on. |
contact - Contact
|
The firm contact this event occurred on. |
electronicAddressId - ID!
|
The ID of the electronic address this event occurred on. |
Example
{
"eventType": "CompanyAddressAdded",
"eventDate": DateTimeOffset,
"contactId": "00000006-0002-0000-0000-000000000000",
"contact": Contact,
"electronicAddressId": "00000006-0002-0000-0000-000000000000"
}
FirmContactEventView
Description
Represents an event that occurred on a firm contact.
Fields
| Field Name | Description |
|---|---|
eventType - FirmContactEventViewType!
|
The type of event that occurred on the firm contact. |
eventDate - DateTimeOffset!
|
The date and time when the event occurred. |
contactId - ID!
|
The ID of the firm contact this event occurred on. |
contact - Contact
|
The firm contact this event occurred on. |
Possible Types
| FirmContactEventView Types |
|---|
Example
{
"eventType": "CompanyAddressAdded",
"eventDate": DateTimeOffset,
"contactId": "00000006-0002-0000-0000-000000000000",
"contact": Contact
}
FirmContactEventViewFilterInput
Description
Input for filtering firm contact events.
Fields
| Input Field | Description |
|---|---|
eventTypes - [FirmContactEventViewType!]
|
The event types to filter firm contact events by. |
eventDateRange - DateTimeOffsetFilterInput
|
The event date range to filter firm contact events by. For third-party clients, start date defaults to 90 days ago. When start date is not provided, start date offset is determined from end date if specified, otherwise defaults to UTC (zero offset). |
contactIds - [ID!]
|
The IDs of the firm contacts to filter firm contact events by. |
Example
{
"eventTypes": ["CompanyAddressAdded"],
"eventDateRange": DateTimeOffsetFilterInput,
"contactIds": [
"00000006-0002-0000-0000-000000000000"
]
}
FirmContactEventViewResults
Fields
| Field Name | Description |
|---|---|
totalModels - Int!
|
The total number of items found. |
models - [FirmContactEventView]
|
The list of firm contact events. |
Example
{"totalModels": 123, "models": [FirmContactEventView]}
FirmContactEventViewSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"eventType"
FirmContactEventViewSortInput
Description
Specifies sorting options for firm contact events, allowing customization of sorting behavior based on the chosen field and direction.
Fields
| Input Field | Description |
|---|---|
field - FirmContactEventViewSortField!
|
Specifies the field to use for sorting firm contact events. |
direction - SortDirection
|
Specifies the sort direction (Ascending or Descending). Default = Ascending |
Example
{"field": "eventType", "direction": "Ascending"}
FirmContactEventViewType
Description
Represents the types of events that can occur on a firm contact.
Values
| Enum Value | Description |
|---|---|
|
|
Indicates that an address was added to a company. |
|
|
Indicates that an address was removed from a company. |
|
|
Indicates that a company's address was updated. Update events are not provided if the address is no longer associated with the company. |
|
|
Indicates that a company's alias was updated. |
|
|
Indicates that an electronic address was added to a company. |
|
|
Indicates that an electronic address was removed from a company. |
|
|
Indicates that a company's electronic address was updated. Update events are not provided if the electronic address is no longer associated with the company. |
|
|
Indicates that a company's name was updated. |
|
|
Indicates that a phone was added to a company. |
|
|
Indicates that a phone was removed from a company. |
|
|
Indicates that a company's phone was updated. Update events are not provided if the phone is no longer associated with the company. |
|
|
Indicates that a contact was created. |
|
|
Indicates that a contact was deleted. |
|
|
Indicates that a person's first name was updated. |
|
|
Indicates that a person's job title was updated. |
|
|
Indicates that a person's last name was updated. |
|
|
Indicates that a person's middle name was updated. |
|
|
Indicates that an address was added to a person. |
|
|
Indicates that an address was removed from a person. |
|
|
Indicates that a person's address was updated. Update events are not provided if the address is no longer associated with the person. |
|
|
Indicates that a person's company was updated. |
|
|
Indicates that an electronic address was added to a person. |
|
|
Indicates that an electronic address was removed from a person. |
|
|
Indicates that a person's electronic address was updated. Update events are not provided if the electronic address is no longer associated with the person. |
|
|
Indicates that a person's goes by name was updated. |
|
|
Indicates that a phone was added to a person. |
|
|
Indicates that a phone was removed from a person. |
|
|
Indicates that a person's phone was updated. Update events are not provided if the phone is no longer associated with the person. |
|
|
Indicates that a person's title was updated. |
Example
"CompanyAddressAdded"
FirmContactGeneralEventView
Description
Represents an event that occurred on a firm contact.
Fields
| Field Name | Description |
|---|---|
eventType - FirmContactEventViewType!
|
The type of event that occurred on the firm contact. |
eventDate - DateTimeOffset!
|
The date and time when the event occurred. |
contactId - ID!
|
The ID of the firm contact this event occurred on. |
contact - Contact
|
The firm contact this event occurred on. |
Example
{
"eventType": "CompanyAddressAdded",
"eventDate": DateTimeOffset,
"contactId": "00000006-0002-0000-0000-000000000000",
"contact": Contact
}
FirmContactPhoneEventView
Description
Represents a phone event that occurred on a firm contact.
Fields
| Field Name | Description |
|---|---|
eventType - FirmContactEventViewType!
|
The type of event that occurred on the firm contact. |
eventDate - DateTimeOffset!
|
The date and time when the event occurred. |
contactId - ID!
|
The ID of the firm contact this event occurred on. |
contact - Contact
|
The firm contact this event occurred on. |
phoneId - ID!
|
The ID of the phone this event occurred on. |
Example
{
"eventType": "CompanyAddressAdded",
"eventDate": DateTimeOffset,
"contactId": "00000006-0002-0000-0000-000000000000",
"contact": Contact,
"phoneId": "00000006-0002-0000-0000-000000000000"
}
FirmNote
Description
Represents a firm note about a contact.
Example
{
"notes": "abc123",
"changeDate": "xyz789",
"noteId": "00000006-0002-0000-0000-000000000000",
"folderId": "00000006-0002-0000-0000-000000000000"
}
FirmSettings
Description
Represents the settings for the firm.
Fields
| Field Name | Description |
|---|---|
minimumRequiredFields - [MinimumRequiredFieldType]
|
The list of minimum required fields for new contacts. |
titles - [String]
|
The list of available titles. |
suffixes - [String]
|
The list of available suffixes. |
languageSettings - LanguageSettings
|
The language settings for the firm. |
genderSettings - GenderSettings
|
The gender settings for the firm. |
defaultNewActivityTypeId - ID
|
The default type ID for new activities. |
Example
{
"minimumRequiredFields": ["none"],
"titles": ["xyz789"],
"suffixes": ["xyz789"],
"languageSettings": LanguageSettings,
"genderSettings": GenderSettings,
"defaultNewActivityTypeId": "00000006-0002-0000-0000-000000000000"
}
Float
Example
987.65
GenderSettings
Description
Represents the gender settings for the firm.
Fields
| Field Name | Description |
|---|---|
genderAdditionalFieldId - ID
|
The additional field ID of the gender field. |
genders - AdditionalFieldDefinition
|
The gender values available to the firm. |
Example
{
"genderAdditionalFieldId": "00000006-0002-0000-0000-000000000000",
"genders": AdditionalFieldDefinition
}
GeneralCustomField
Description
Represents a custom field with no additional configuration.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the custom field. |
displayName - String
|
The display name of the custom field. |
description - String
|
The description of the custom field. |
required - Boolean
|
Indicates whether the custom field is required. |
isActive - Boolean
|
Indicates whether the custom field is active. |
canRemove - Boolean
|
Indicates whether the custom field can be removed. |
control - CustomFieldControl
|
The control for the custom field. |
createDate - Date
|
The date the custom field was created. |
changeDate - Date
|
The date the custom field was last changed. |
displayOrder - Int
|
The display order of the custom field. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "xyz789",
"description": "xyz789",
"required": true,
"isActive": false,
"canRemove": false,
"control": CustomFieldControl,
"createDate": "2007-12-03",
"changeDate": "2007-12-03",
"displayOrder": 123
}
GetContactTypeInput
Description
Input for retrieving contact types.
Fields
| Input Field | Description |
|---|---|
contactEntity - ContactEntity
|
The entity type of contact to retrieve (Person, Company). |
frequentOnly - Boolean
|
Set to true to retrieve only frequently used contact types. |
sourceFolderId - String
|
The ID of the source folder for the contact type. |
sortOrder - String
|
Specify the sort field for the contact types. Sort order will always be ascending. Set one of the following values:
|
Example
{
"contactEntity": "Any",
"frequentOnly": false,
"sourceFolderId": "xyz789",
"sortOrder": "abc123"
}
HyperlinkCustomField
Description
Represents a custom field that stores a hyperlink value.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the hyperlink custom field. |
displayName - String
|
The display name of the hyperlink custom field. |
description - String
|
The description of the hyperlink custom field. |
required - Boolean
|
Indicates whether the hyperlink custom field is required. |
isActive - Boolean
|
Indicates whether the hyperlink custom field is active. |
canRemove - Boolean
|
Indicates whether the hyperlink custom field can be removed. |
control - CustomFieldControl
|
The control for the hyperlink custom field. |
createDate - Date
|
The date the hyperlink custom field was created. |
changeDate - Date
|
The date the hyperlink custom field was last changed. |
displayOrder - Int
|
The display order of the hyperlink custom field. |
maxSize - Int
|
The maximum size of the hyperlink value. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "abc123",
"description": "xyz789",
"required": true,
"isActive": true,
"canRemove": true,
"control": CustomFieldControl,
"createDate": "2007-12-03",
"changeDate": "2007-12-03",
"displayOrder": 123,
"maxSize": 987
}
ID
Example
"00000006-0002-0000-0000-000000000000"
Industry
IndustryResults
Fields
| Field Name | Description |
|---|---|
totalModels - Int!
|
The total number of items found. |
models - [Industry]
|
The list of industries. |
Example
{"totalModels": 123, "models": [Industry]}
Initiative
Description
Represents a business planning initiative.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the initiative. |
name - String
|
The name of the initiative. |
description - String
|
The description of the initiative. |
startDate - Date
|
The start date of the initiative. |
endDate - Date
|
The end date of the initiative. |
closedDate - Date
|
The close date of the initiative. |
status - Status
|
The status of the initiative. |
creatorId - ID
|
The ID of the user who created the initiative. |
createdBy - String
|
The name of the user who created the initiative. |
progress - Float
|
The progress of the initiative, expressed as a fraction from 0 to 1 (where 1 represents 100% complete). |
isDeleted - Boolean
|
Indicates whether the initiative is deleted. |
objective - Objective
|
The objective linked to this initiative. |
companies - [BusinessPlanningInitiativeCompany]
|
The list of companies associated with this initiative. |
locations - [BusinessPlanningLocation]
|
The list of locations linked to this initiative. |
involvedUsers - [BusinessPlanningPerson]
|
The list of users involved in this initiative. |
companyEmployeeRelationships - BusinessPlanningConnectionResults
|
The list of company employee relationships associated with this initiative. |
Arguments
|
|
companyEmployees - CompanyEmployeeResults
|
The list of company employees associated with this initiative. |
Arguments
|
|
tags - [BusinessPlanningTag]
|
The list of tags associated with this initiative. |
types - BusinessPlanningTypes
|
The types associated with this initiative. |
activityCounts - InitiativeActivityCountResults
|
The activity counts for this initiative. |
Arguments
|
|
activities - InitiativeActivityResults
|
The list of activities associated with this initiative. |
Arguments
|
|
measurementOfSuccess - BusinessPlanningMeasurementOfSuccess
|
The measurement of success for this initiative. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"description": "abc123",
"startDate": "2007-12-03",
"endDate": "2007-12-03",
"closedDate": "2007-12-03",
"status": "open",
"creatorId": "00000006-0002-0000-0000-000000000000",
"createdBy": "xyz789",
"progress": 123.45,
"isDeleted": true,
"objective": Objective,
"companies": [BusinessPlanningInitiativeCompany],
"locations": [BusinessPlanningLocation],
"involvedUsers": [BusinessPlanningPerson],
"companyEmployeeRelationships": BusinessPlanningConnectionResults,
"companyEmployees": CompanyEmployeeResults,
"tags": [BusinessPlanningTag],
"types": BusinessPlanningTypes,
"activityCounts": InitiativeActivityCountResults,
"activities": InitiativeActivityResults,
"measurementOfSuccess": BusinessPlanningMeasurementOfSuccess
}
InitiativeActivityCount
Description
Represents an activity count for an initiative.
Example
{
"companyId": "00000006-0002-0000-0000-000000000000",
"companyName": "xyz789",
"month": 987,
"year": 987,
"count": 987
}
InitiativeActivityCountResults
Fields
| Field Name | Description |
|---|---|
totalModels - Int!
|
The total number of items found. |
models - [InitiativeActivityCount]
|
The list of initiative activity counts. |
Example
{"totalModels": 123, "models": [InitiativeActivityCount]}
InitiativeActivityFilterInput
Description
Input for filtering the initiative activity counts.
Fields
| Input Field | Description |
|---|---|
activityDate - DateFilterInput
|
The activity date range to filter the activity counts by. |
Example
{"activityDate": DateFilterInput}
InitiativeActivityResults
Fields
| Field Name | Description |
|---|---|
skip - Int
|
The starting index for pagination. |
limit - Int
|
The maximum number of items to retrieve. |
sort - Sort
|
The sorting options applied to the results. |
models - [BusinessPlanningActivity]
|
The list of activities. |
totalModels - Int
|
The total number of items found. |
Example
{
"skip": 987,
"limit": 123,
"sort": Sort,
"models": [BusinessPlanningActivity],
"totalModels": 987
}
InitiativeFilterInput
Description
Input for filtering the initiatives.
Fields
| Input Field | Description |
|---|---|
name - StringFilterInput
|
The name filter criteria for the initiatives. |
parentObjectiveId - ID
|
The ID of the parent objective to filter the initiatives by. |
companyId - ID
|
The ID of the company to filter the initiatives by. |
startDate - DateFilterInput
|
The start date range to filter the initiatives by. |
endDate - DateFilterInput
|
The end date range to filter the initiatives by. |
status - Status
|
The status to filter the initiatives by. |
country - String
|
The country to filter the initiatives by. |
administrativeDivision - String
|
The administrative division to filter the initiatives by. |
industryNames - [String]
|
The list of industry names to filter the initiatives by. |
practiceGroupNames - [String]
|
The list of practice group names to filter the initiatives by. |
createdBy - String
|
The creator to filter the initiatives by. |
Example
{
"name": StringFilterInput,
"parentObjectiveId": "00000006-0002-0000-0000-000000000000",
"companyId": "00000006-0002-0000-0000-000000000000",
"startDate": DateFilterInput,
"endDate": DateFilterInput,
"status": "open",
"country": "xyz789",
"administrativeDivision": "xyz789",
"industryNames": ["abc123"],
"practiceGroupNames": ["xyz789"],
"createdBy": "abc123"
}
InitiativeResults
Fields
| Field Name | Description |
|---|---|
skip - Int
|
The starting index for pagination. |
limit - Int
|
The maximum number of items to retrieve. |
sort - Sort
|
The sorting options applied to the results. |
totalModels - Int!
|
The total number of items found. |
models - [Initiative]
|
The list of initiatives. |
Example
{
"skip": 987,
"limit": 123,
"sort": Sort,
"totalModels": 123,
"models": [Initiative]
}
InitiativeSortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"name"
InitiativeSortInput
Description
Input for sorting the initiatives.
Fields
| Input Field | Description |
|---|---|
field - InitiativeSortField!
|
The field to sort the initiatives by. |
direction - SortDirection
|
The direction to sort the initiatives in. Default = Ascending |
Example
{"field": "name", "direction": "Ascending"}
Int
Example
123
InvolvedUserField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"initiativeName"
InvolvedUserFilter
Description
Input for filtering the involved users.
Fields
| Input Field | Description |
|---|---|
initiativeName - String
|
The initiative name to filter the involved users by. |
firstName - String
|
The first name to filter the involved users by. |
lastName - String
|
The last name to filter the involved users by. |
jobTitle - String
|
The job title to filter the involved users by. |
companyName - String
|
The company name to filter the involved users by. |
distinctUsersOnly - Boolean
|
Whether to return only distinct users. Default = false |
Example
{
"initiativeName": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"jobTitle": "xyz789",
"companyName": "abc123",
"distinctUsersOnly": true
}
InvolvedUserSort
Description
Input for sorting the involved users.
Fields
| Input Field | Description |
|---|---|
field - InvolvedUserField!
|
The field to sort the involved users by. |
direction - SortDirection
|
The direction to sort the involved users in. Default = Ascending |
Example
{"field": "initiativeName", "direction": "Ascending"}
Language
Description
Represents a language for the firm.
Example
{
"label": "abc123",
"enumId": "abc123",
"value": "xyz789",
"isActive": true,
"description": "abc123"
}
LanguageResults
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the language. |
languages - [Language]
|
The list of languages. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"languages": [Language]
}
LanguageSettings
Description
Represents the language settings for the firm.
Fields
| Field Name | Description |
|---|---|
languageSpecificInfoEnabled - Boolean
|
Indicates whether language-specific contact information fields are enabled. |
languageAdditionalFieldId - ID
|
The additional field ID of the language field. |
languages - LanguageResults
|
The list of available languages. |
Example
{
"languageSpecificInfoEnabled": true,
"languageAdditionalFieldId": "00000006-0002-0000-0000-000000000000",
"languages": LanguageResults
}
LocationChangeAddressInput
Description
Input for updating a location's address.
Fields
| Input Field | Description |
|---|---|
addressId - ID
|
The ID of the address. |
label - String
|
The label for this address. |
street - String
|
The street for this address. |
city - String
|
The city for this address (city, town, village, etc.). |
administrativeDivision - String
|
The administrative division for this address. This represents a state, province, governorate, department, or similar regional division depending on the country. This field may not be applicable for all countries. |
country - String
|
The country for this address. |
postalCode - String
|
The ZIP or postal code for this address. This field may not be applicable for all countries. |
additionalField - String
|
The additional information for this address. |
owningContactId - ID
|
The ID of the contact that owns this address. |
isMailingAddress - Boolean
|
Indicates whether this is a mailing address. |
Example
{
"addressId": "00000006-0002-0000-0000-000000000000",
"label": "abc123",
"street": "abc123",
"city": "abc123",
"administrativeDivision": "xyz789",
"country": "abc123",
"postalCode": "xyz789",
"additionalField": "abc123",
"owningContactId": "00000006-0002-0000-0000-000000000000",
"isMailingAddress": true
}
LocationChangeElectronicAddressInput
Description
Input for updating a location's electronic address.
Example
{
"owningContactId": "00000006-0002-0000-0000-000000000000",
"electronicAddress": "xyz789"
}
LocationChangeInput
Description
Input for updating a contact's location.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the contact associated with this location. |
jobTitle - String
|
The job title for the contact at this location. |
assistantName - String
|
The name of the assistant for the contact at this location. |
businessAddress - LocationChangeAddressInput
|
The business address for this contact's location. |
businessPhoneNumber - LocationChangePhoneInput
|
The primary business phone number for this contact's location. |
business2PhoneNumber - LocationChangePhoneInput
|
The secondary business phone number for this contact's location. |
mobilePhoneNumber - LocationChangePhoneInput
|
The mobile phone number for this contact's location. |
businessFaxNumber - LocationChangePhoneInput
|
The business fax number for this contact's location. |
pagerNumber - LocationChangePhoneInput
|
The pager number for this contact's location. |
businessElectronicAddress - LocationChangeElectronicAddressInput
|
The business email address for this contact's location. |
businessWebsite - LocationChangeElectronicAddressInput
|
The business website address for this contact's location. |
assistantPhoneNumber - LocationChangePhoneInput
|
The phone number of the assistant for the contact at this location. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"jobTitle": "xyz789",
"assistantName": "xyz789",
"businessAddress": LocationChangeAddressInput,
"businessPhoneNumber": LocationChangePhoneInput,
"business2PhoneNumber": LocationChangePhoneInput,
"mobilePhoneNumber": LocationChangePhoneInput,
"businessFaxNumber": LocationChangePhoneInput,
"pagerNumber": LocationChangePhoneInput,
"businessElectronicAddress": LocationChangeElectronicAddressInput,
"businessWebsite": LocationChangeElectronicAddressInput,
"assistantPhoneNumber": LocationChangePhoneInput
}
LocationChangePhoneInput
LocationInput
Long
Example
10301
MailingAddressType
Description
The available mailing address types.
Values
| Enum Value | Description |
|---|---|
|
|
Indicates that the mailing address type is not specified. |
|
|
Indicates that the mailing address type is a home address. |
|
|
Indicates that the mailing address type is a business address. |
|
|
Indicates that the mailing address type is other than home or business. |
Example
"None"
MeasurementType
Description
The available measurement type options.
Values
| Enum Value | Description |
|---|---|
|
|
The measurement is expressed as a currency amount. |
|
|
The measurement is expressed as a number. |
|
|
The measurement is expressed as a percentage. |
Example
"currency"
MinimumRequiredFieldType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"none"
MoneyInput
MutateAdditionalFieldResults
Fields
| Field Name | Description |
|---|---|
models - [UpdateListContactAdditionalFieldResults]
|
The list of updated additional fields. |
Example
{"models": [UpdateListContactAdditionalFieldResults]}
MutateCompanyResults
Fields
| Field Name | Description |
|---|---|
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
item - Company
|
The updated company. |
Example
{
"validationErrors": [ValidationErrors],
"item": Company
}
MutateLocationResults
Fields
| Field Name | Description |
|---|---|
status - ResultCode
|
Status of the changes to the location. |
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
item - Contact
|
The updated contact. |
Example
{
"status": "NoChange",
"validationErrors": [ValidationErrors],
"item": Contact
}
MutatePersonResults
Fields
| Field Name | Description |
|---|---|
status - ResultCode
|
Status of the changes to the person. |
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
item - Person
|
The updated person. |
Example
{
"status": "NoChange",
"validationErrors": [ValidationErrors],
"item": Person
}
NoteResults
Fields
| Field Name | Description |
|---|---|
totalModels - Int!
|
The total number of items found. |
models - [FirmNote]
|
The list of notes. |
Example
{"totalModels": 123, "models": [FirmNote]}
Notes
Description
Represents the notes associated with a contact.
Fields
| Field Name | Description |
|---|---|
allNotes - NoteResults
|
All notes about the contact (firm notes and 'my' notes). |
Example
{"allNotes": NoteResults}
NumberType
Description
Specifies the numeric value format that can be used.
Values
| Enum Value | Description |
|---|---|
|
|
The number is a whole number. |
|
|
The number is a decimal. |
Example
"wholeNumber"
Objective
Description
Represents a business planning objective.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the objective. |
name - String
|
The name of the objective. |
description - String
|
The description of the objective. |
startDate - Date
|
The start date of the objective. |
endDate - Date
|
The end date of the objective. |
closedDate - Date
|
The close date of the objective. |
createdBy - String
|
The name of the user who created the objective. |
isDeleted - Boolean
|
Indicates whether the objective is deleted. |
progress - Int
|
The progress of the objective from 0 to 100. |
status - Status
|
The status of the objective. |
canClose - Boolean
|
Indicates whether the objective can be closed. |
creatorId - ID
|
The ID of the user who created the objective. |
measurementOfSuccess - BusinessPlanningMeasurementOfSuccess
|
The measurement of success for this objective. |
initiatives - InitiativeResults
|
The list of initiatives associated with this objective. |
Arguments
|
|
tags - [BusinessPlanningTag]
|
The list of tags associated with this objective. |
types - BusinessPlanningTypes
|
The types associated with this objective. |
locations - [BusinessPlanningLocation]
|
The list of locations associated with this objective. |
activityCounts - ObjectiveActivityCountResults
|
The activity counts for this objective. |
Arguments
|
|
activities - InitiativeActivityResults
|
The list of activities associated with this objective. |
Arguments
|
|
involvedUsers - ObjectivePersonResults
|
The list of users involved in this objective. |
Arguments
|
|
initiativeCompanies - BusinessPlanningInitiativeCompanyResults
|
The list of initiative companies associated with this objective. |
Arguments
|
|
companies - BusinessPlanningObjectiveCompanyResults
|
The list of companies associated with this objective. |
Arguments
|
|
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"description": "xyz789",
"startDate": "2007-12-03",
"endDate": "2007-12-03",
"closedDate": "2007-12-03",
"createdBy": "xyz789",
"isDeleted": true,
"progress": 123,
"status": "open",
"canClose": true,
"creatorId": "00000006-0002-0000-0000-000000000000",
"measurementOfSuccess": BusinessPlanningMeasurementOfSuccess,
"initiatives": InitiativeResults,
"tags": [BusinessPlanningTag],
"types": BusinessPlanningTypes,
"locations": [BusinessPlanningLocation],
"activityCounts": ObjectiveActivityCountResults,
"activities": InitiativeActivityResults,
"involvedUsers": ObjectivePersonResults,
"initiativeCompanies": BusinessPlanningInitiativeCompanyResults,
"companies": BusinessPlanningObjectiveCompanyResults
}
ObjectiveActivityCount
Description
Aggregates the number of activities logged against an objective, grouped by the contributing initiative and calendar month.
Fields
| Field Name | Description |
|---|---|
initiativeId - ID
|
Identify the initiative whose activities are counted in this record. |
initiativeName - String
|
Display the name of the initiative whose activities are counted in this record. |
month - Int
|
Specify the calendar month the activities were logged in, represented as an integer. |
year - Int
|
Specify the calendar year the activities were logged in. |
count - Int
|
Report the total number of activities logged for the initiative during the given month and year. |
Example
{
"initiativeId": "00000006-0002-0000-0000-000000000000",
"initiativeName": "xyz789",
"month": 123,
"year": 987,
"count": 123
}
ObjectiveActivityCountResults
Description
Return a paged collection of objective activity counts together with the total number of matching records.
Fields
| Field Name | Description |
|---|---|
totalModels - Int!
|
Report the total number of objective activity counts that match the query, ignoring paging. |
models - [ObjectiveActivityCount]
|
List the objective activity counts returned for the current page. |
Example
{"totalModels": 123, "models": [ObjectiveActivityCount]}
ObjectiveActivityFilterInput
Description
Input for filtering the objective activity counts.
Fields
| Input Field | Description |
|---|---|
activityDate - DateFilterInput
|
The activity date range to filter the objective activities by. |
Example
{"activityDate": DateFilterInput}
ObjectivePerson
Description
Represents a person involved in an objective.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the contact. |
firstName - String
|
The first name of the contact. |
lastName - String
|
The last name of the contact. |
jobTitle - String
|
The job title of the contact. |
companyName - String
|
The company name of the contact. |
initiativeName - String
|
The name of the initiative. |
initiativeId - ID
|
The ID of the initiative. |
initiativeChangeDate - Date
|
The date the contact's initiative association changed. |
person - Person
|
The contact record for this person. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"firstName": "xyz789",
"lastName": "xyz789",
"jobTitle": "xyz789",
"companyName": "xyz789",
"initiativeName": "xyz789",
"initiativeId": "00000006-0002-0000-0000-000000000000",
"initiativeChangeDate": "2007-12-03",
"person": Person
}
ObjectivePersonResults
Description
Represents the results of a query for the users involved in an objective.
Fields
| Field Name | Description |
|---|---|
skip - Int
|
The starting index for pagination. |
limit - Int
|
The maximum number of items to retrieve. |
sort - Sort
|
The sorting options applied to the results. |
totalModels - Int!
|
The total number of items found. |
models - [ObjectivePerson]
|
The list of involved users. |
Example
{
"skip": 987,
"limit": 987,
"sort": Sort,
"totalModels": 987,
"models": [ObjectivePerson]
}
Opportunity
Description
Represents an opportunity.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the opportunity. |
title - String
|
The title of the opportunity. |
description - String
|
The description of the opportunity. |
creatorId - ID
|
The ID of the user who created the opportunity. |
targetCompany - Company
|
The target company for the opportunity. |
opportunityType - OpportunityType
|
The type of the opportunity. |
actualOutcome - OpportunityOutcome
|
The outcome of the opportunity. |
actualOutcomeReason - OpportunityOutcomeReason
|
The reason for the opportunity outcome. |
associatedOutcomeReasons - [OpportunityOutcomeReasonCollection!]
|
The list of outcome reasons associated with this opportunity. |
originationSource - OpportunityOriginationSource
|
The origination source of the opportunity. |
originationSourceContact - Person
|
The person who originated the opportunity. |
originationSourceCompany - Company
|
The company from which the opportunity originated. |
associatedPrincipals - [OpportunityLead!]
|
The list of users and groups associated with this opportunity. |
associatedContacts - [OpportunityTargetCompanyContact!]
|
The list of contacts associated with this opportunity. |
stageInstances - [OpportunityStageInstance!]
|
The stage instances for the opportunity. |
estimatedCloseDate - Date
|
The estimated close date of the opportunity. |
dateOpened - Date
|
The date when the opportunity was opened. |
actualCloseDate - Date
|
The actual close date of the opportunity. |
associatedMatter - String
|
The associated matter for the opportunity. |
associatedInitiative - Initiative
|
The initiative associated with this opportunity. |
activities - InitiativeActivityResults
|
The list of activities associated with this opportunity. |
Arguments
|
|
practiceGroups - [PracticeGroup!]
|
The list of practice groups associated with this opportunity. |
industries - [Industry!]
|
The list of industries associated with this opportunity. |
workTypeId - ID
|
The work type ID for the opportunity. |
status - OpportunityStatus
|
The status of the opportunity. |
isConfidential - Boolean
|
Indicates whether the opportunity is marked as confidential. |
shouldBeHidden - Boolean
|
Indicates whether this opportunity should be hidden from the current user due to visibility rules. |
isCurrentUserInvolved - Boolean
|
Indicates whether the current user is involved in this opportunity. |
lead - Person
|
The primary lead for the opportunity. |
tags - [OpportunityTag]
|
The list of tags associated with this opportunity. |
currentStage - OpportunityStageInstance
|
The current stage of the opportunity. |
associatedInitiatives - [Initiative]
|
The list of initiatives linked to this opportunity. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"title": "abc123",
"description": "xyz789",
"creatorId": "00000006-0002-0000-0000-000000000000",
"targetCompany": Company,
"opportunityType": OpportunityType,
"actualOutcome": OpportunityOutcome,
"actualOutcomeReason": OpportunityOutcomeReason,
"associatedOutcomeReasons": [
OpportunityOutcomeReasonCollection
],
"originationSource": OpportunityOriginationSource,
"originationSourceContact": Person,
"originationSourceCompany": Company,
"associatedPrincipals": [OpportunityLead],
"associatedContacts": [OpportunityTargetCompanyContact],
"stageInstances": [OpportunityStageInstance],
"estimatedCloseDate": "2007-12-03",
"dateOpened": "2007-12-03",
"actualCloseDate": "2007-12-03",
"associatedMatter": "xyz789",
"associatedInitiative": Initiative,
"activities": InitiativeActivityResults,
"practiceGroups": [PracticeGroup],
"industries": [Industry],
"workTypeId": "00000006-0002-0000-0000-000000000000",
"status": "open",
"isConfidential": true,
"shouldBeHidden": true,
"isCurrentUserInvolved": false,
"lead": Person,
"tags": [OpportunityTag],
"currentStage": OpportunityStageInstance,
"associatedInitiatives": [Initiative]
}
OpportunityEventView
Description
Represents an event where a tracked field on an opportunity changed (dateOpened, currentStage, or status).
Fields
| Field Name | Description |
|---|---|
eventType - OpportunityEventViewType!
|
The type of event that occurred on the opportunity. |
eventDate - DateTimeOffset!
|
The date and time when the event occurred. |
opportunityId - ID!
|
The ID of the opportunity this event occurred on. |
opportunity - Opportunity
|
The opportunity this event occurred on. |
Example
{
"eventType": "DateOpenedChanged",
"eventDate": DateTimeOffset,
"opportunityId": "00000006-0002-0000-0000-000000000000",
"opportunity": Opportunity
}
OpportunityEventViewFilterInput
Description
Input for filtering opportunity events.
Fields
| Input Field | Description |
|---|---|
eventTypes - [OpportunityEventViewType!]
|
The event types to filter opportunity events by. |
eventDateRange - DateTimeOffsetFilterInput
|
The event date range to filter opportunity events by. For third-party clients, start date defaults to 90 days ago. When start date is not provided, start date offset is determined from end date if specified, otherwise defaults to UTC (zero offset). |
opportunityIds - [ID!]
|
The IDs of the opportunities to filter opportunity events by. |
Example
{
"eventTypes": ["DateOpenedChanged"],
"eventDateRange": DateTimeOffsetFilterInput,
"opportunityIds": [
"00000006-0002-0000-0000-000000000000"
]
}
OpportunityEventViewResults
Fields
| Field Name | Description |
|---|---|
totalModels - Int!
|
The total number of items found. |
models - [OpportunityEventView]
|
The list of opportunity events. |
Example
{"totalModels": 987, "models": [OpportunityEventView]}
OpportunityEventViewSortField
Description
Specifies the fields available for sorting opportunity events.
Values
| Enum Value | Description |
|---|---|
|
|
Sort by the type of event. |
|
|
Sort by the date the event occurred. |
|
|
Sort by the ID of the opportunity the event occurred on. |
Example
"EventType"
OpportunityEventViewSortInput
Description
Specifies sorting options for opportunity events, allowing customization of sorting behavior based on the chosen field and direction.
Fields
| Input Field | Description |
|---|---|
field - OpportunityEventViewSortField!
|
Specifies the field to use for sorting opportunity events. |
direction - SortDirection
|
Specifies the sort direction (Ascending or Descending). Default = Ascending |
Example
{"field": "EventType", "direction": "Ascending"}
OpportunityEventViewType
Description
Represents the types of events that can occur on an opportunity.
Values
| Enum Value | Description |
|---|---|
|
|
Indicates that the opportunity's dateOpened changed. |
|
|
Indicates that the opportunity's currentStage changed. |
|
|
Indicates that the opportunity's status changed. |
Example
"DateOpenedChanged"
OpportunityFilterInput
Fields
| Input Field | Description |
|---|---|
isConfidential - Boolean
|
Indicates whether to filter by confidential opportunities. |
title - String
|
The opportunity title to filter by. |
targetCompanyName - String
|
The target company name to filter opportunities by. |
opportunityTypeName - String
|
The opportunity type name to filter by. |
targetCompanyId - ID
|
The ID of the target company to filter by. |
associatedContactId - ID
|
The ID of an associated contact to filter by. |
associatedPrincipalsContactId - ID
|
The ID of an associated principal (user or group) to filter by. |
status - OpportunityStatus
|
The status of the opportunity to filter by. |
associatedInitiativeId - ID
|
The ID of an associated initiative to filter by. |
leadName - String
|
The name of the lead to filter by. |
industryNames - [String]
|
The list of industry names to filter by. |
practiceGroupNames - [String]
|
The list of practice group names to filter by. |
involveCurrentUser - Boolean
|
Indicates whether to filter for opportunities involving the current user. |
startDate - DateTime
|
The start date to filter opportunities by. |
Example
{
"isConfidential": false,
"title": "abc123",
"targetCompanyName": "xyz789",
"opportunityTypeName": "xyz789",
"targetCompanyId": "00000006-0002-0000-0000-000000000000",
"associatedContactId": "00000006-0002-0000-0000-000000000000",
"associatedPrincipalsContactId": "00000006-0002-0000-0000-000000000000",
"status": "open",
"associatedInitiativeId": "00000006-0002-0000-0000-000000000000",
"leadName": "abc123",
"industryNames": ["abc123"],
"practiceGroupNames": ["xyz789"],
"involveCurrentUser": true,
"startDate": "2007-12-03T10:15:30Z"
}
OpportunityLead
Description
Represents a user or group associated with an opportunity.
Fields
| Field Name | Description |
|---|---|
opportunityId - ID
|
The ID of the opportunity. |
accountName - String
|
The account name for the lead. |
isGroup - Boolean
|
Indicates whether this is a group or a user reference. |
isPrimary - Boolean
|
Indicates whether this is the primary lead of the opportunity. |
fullName - String
|
The full name of the lead. |
leadId - ID
|
The ID of the lead. |
Example
{
"opportunityId": "00000006-0002-0000-0000-000000000000",
"accountName": "xyz789",
"isGroup": false,
"isPrimary": false,
"fullName": "xyz789",
"leadId": "00000006-0002-0000-0000-000000000000"
}
OpportunityLinkInput
Description
Represents a link associated with an opportunity.
Fields
| Input Field | Description |
|---|---|
linkType - OpportunityLinkType!
|
The type of the linked object. |
linkId - ID
|
The ID of the linked object. |
Example
{
"linkType": "Opportunity",
"linkId": "00000006-0002-0000-0000-000000000000"
}
OpportunityLinkType
Description
The available opportunity link types.
Values
| Enum Value | Description |
|---|---|
|
|
Indicates that the linked object is an opportunity. |
|
|
Indicates that the linked object is an initiative. |
Example
"Opportunity"
OpportunityOriginationSource
Description
Represents a source from which an opportunity originated.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "xyz789",
"description": "xyz789",
"isActive": false
}
OpportunityOriginationSourceInput
Description
Input for creating or updating opportunity origination sources.
Fields
| Input Field | Description |
|---|---|
addOpportunityOriginationSourceInputs - [AddOpportunityOriginationSourceInput!]
|
The list of opportunity origination sources to add. |
updateOpportunityOriginationSourceInputs - [UpdateOpportunityOriginationSourceInput!]
|
The list of opportunity origination sources to update. |
Example
{
"addOpportunityOriginationSourceInputs": [
AddOpportunityOriginationSourceInput
],
"updateOpportunityOriginationSourceInputs": [
UpdateOpportunityOriginationSourceInput
]
}
OpportunityOutcome
Description
Represents an opportunity outcome.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the opportunity outcome. |
name - String
|
The name of the opportunity outcome. |
description - String
|
The description of the opportunity outcome. |
reasons - [OpportunityOutcomeReason]
|
The opportunity outcome reasons for this outcome. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"description": "abc123",
"reasons": [OpportunityOutcomeReason]
}
OpportunityOutcomeMultiselectReason
Description
Represents a selected opportunity outcome reason.
Fields
| Input Field | Description |
|---|---|
reasonId - ID!
|
The ID of the opportunity outcome reason. |
Example
{
"reasonId": "00000006-0002-0000-0000-000000000000"
}
OpportunityOutcomeReason
Description
Represents a reason for an opportunity outcome.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the opportunity outcome reason. |
name - String
|
The name of the outcome reason. |
description - String
|
The description of the outcome reason. |
outcomeId - ID
|
The ID of the opportunity outcome for this reason. |
isActive - Boolean
|
Indicates whether the outcome reason is active. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"description": "abc123",
"outcomeId": "00000006-0002-0000-0000-000000000000",
"isActive": false
}
OpportunityOutcomeReasonCollection
Description
Represents a collection of outcome reasons for an opportunity.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the outcome reason in this collection. |
name - String
|
The name of the outcome reason. |
opportunityId - ID
|
The ID of the opportunity. |
outcomeId - ID
|
The ID of the opportunity outcome for this reason. |
outcomeReason - OpportunityOutcomeReason
|
The outcome reason details. |
outcome - OpportunityOutcome
|
The outcome details. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "xyz789",
"opportunityId": "00000006-0002-0000-0000-000000000000",
"outcomeId": "00000006-0002-0000-0000-000000000000",
"outcomeReason": OpportunityOutcomeReason,
"outcome": OpportunityOutcome
}
OpportunityOutcomeReasonInput
Description
Input for creating or updating opportunity outcome reasons.
Fields
| Input Field | Description |
|---|---|
addOpportunityOutcomeReasons - [AddOpportunityOutcomeReasonInput!]
|
The list of opportunity outcome reasons to add. |
updateOpportunityOutcomeReasons - [UpdateOpportunityOutcomeReasonInput!]
|
The list of opportunity outcome reasons to update. |
Example
{
"addOpportunityOutcomeReasons": [
AddOpportunityOutcomeReasonInput
],
"updateOpportunityOutcomeReasons": [
UpdateOpportunityOutcomeReasonInput
]
}
OpportunityResults
Fields
| Field Name | Description |
|---|---|
totalModels - Int!
|
The total number of opportunities found. |
models - [Opportunity]
|
The list of opportunities. |
Example
{"totalModels": 123, "models": [Opportunity]}
OpportunitySortField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"title"
OpportunitySortInput
Fields
| Input Field | Description |
|---|---|
field - OpportunitySortField!
|
The field to sort opportunities by. |
direction - SortDirection
|
The sorting direction for the opportunities (Ascending or Descending). Default = Ascending |
Example
{"field": "title", "direction": "Ascending"}
OpportunityStageInstance
Description
Represents a stage instance for an opportunity.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the stage instance. |
opportunityId - ID
|
The ID of the opportunity for this stage. |
stageName - String
|
The name of the stage. |
stageOrder - Int
|
The order position of this stage. |
timeEntered - DateTime
|
The date and time when the stage was entered. |
timeSpent - BigInt
|
The number of days spent in this stage. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"opportunityId": "00000006-0002-0000-0000-000000000000",
"stageName": "xyz789",
"stageOrder": 987,
"timeEntered": "2007-12-03T10:15:30Z",
"timeSpent": {}
}
OpportunityStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"open"
OpportunityTag
Description
Represents a tag associated with an opportunity.
Fields
| Field Name | Description |
|---|---|
type - OpportunityTagType
|
The type of the opportunity tag. |
displayName - String
|
The display name for the tag. |
Example
{
"type": "industry",
"displayName": "xyz789"
}
OpportunityTagType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"industry"
OpportunityTargetCompanyContact
Description
Represents a contact at the target company for an opportunity.
Fields
| Field Name | Description |
|---|---|
opportunityId - ID
|
The ID of the opportunity for this contact. |
contactId - ID
|
The listing ID of the target company contact. |
person - Person
|
The person for this target company contact. |
isPrimary - Boolean
|
Indicates whether this is the primary contact at the target company. |
Example
{
"opportunityId": "00000006-0002-0000-0000-000000000000",
"contactId": "00000006-0002-0000-0000-000000000000",
"person": Person,
"isPrimary": true
}
OpportunityTargetCompanyContactInput
Description
Represents a target company contact associated with an opportunity.
Example
{
"contactId": "00000006-0002-0000-0000-000000000000",
"isPrimary": true
}
OpportunityTeamMemberInput
Description
Represents a team member associated with an opportunity.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"isPrimary": false,
"isGroup": false
}
OpportunityType
Description
Represents an opportunity type.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"description": "abc123",
"isActive": true
}
OpportunityTypeInput
Description
Input for creating or updating opportunity types.
Fields
| Input Field | Description |
|---|---|
addOpportunityTypes - [AddOpportunityTypeInput!]
|
The list of opportunity types to add. |
updateOpportunityTypes - [UpdateOpportunityTypeInput!]
|
The list of opportunity types to update. |
Example
{
"addOpportunityTypes": [AddOpportunityTypeInput],
"updateOpportunityTypes": [UpdateOpportunityTypeInput]
}
PatchOpportunityOriginationSourceResult
Description
Represents the result of adding or updating opportunity origination sources.
Fields
| Field Name | Description |
|---|---|
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
addItems - [OpportunityOriginationSource]
|
The list of opportunity origination sources that were added. |
updateItems - [OpportunityOriginationSource]
|
The list of opportunity origination sources that were updated. |
Example
{
"validationErrors": [ValidationErrors],
"addItems": [OpportunityOriginationSource],
"updateItems": [OpportunityOriginationSource]
}
PatchOpportunityOutcomeReasonResult
Description
Represents the result of adding or updating opportunity outcome reasons.
Fields
| Field Name | Description |
|---|---|
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
addItems - [OpportunityOutcomeReason]
|
The list of opportunity outcome reasons that were added. |
updateItems - [OpportunityOutcomeReason]
|
The list of opportunity outcome reasons that were updated. |
Example
{
"validationErrors": [ValidationErrors],
"addItems": [OpportunityOutcomeReason],
"updateItems": [OpportunityOutcomeReason]
}
PatchOpportunityTypeResult
Description
Represents the result of adding or updating opportunity types.
Fields
| Field Name | Description |
|---|---|
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
addItems - [OpportunityType]
|
The list of opportunity types that were added. |
updateItems - [OpportunityType]
|
The list of opportunity types that were updated. |
Example
{
"validationErrors": [ValidationErrors],
"addItems": [OpportunityType],
"updateItems": [OpportunityType]
}
Person
Description
Represents a person contact.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the person. |
displayName - String
|
The display name of the person. |
contactEntity - ContactEntity
|
The entity type of the contact (Person). |
notes - Notes
|
The firm notes and 'my' notes about the person. |
visibility - ContactVisibility
|
The visibility settings of the person. |
relationshipScore - Score
|
The relationship score of the person. |
isEmployee - Boolean
|
Indicates whether the person is an employee of the firm. |
isPendingFirmContact - Boolean!
|
Indicates whether this person is pending to be linked as My Contact and Firm Contact. |
title - String
|
The title of the person. |
firstName - String
|
The first name of the person. |
middleName - String
|
The middle name of the person. |
lastName - String
|
The last name of the person. |
fullName - String
|
The full name of the person. |
suffix - String
|
The suffix of the person. |
goesBy - String
|
The preferred name or nickname of the person. |
currentJobTitle - String
|
The current job title of the person. |
currentEmployer - Company
|
The current employer of the person. |
assistantName - String
|
The name of the person's assistant. |
contactTypes - [ContactFolderContactType]
|
The list of contact types associated with the person. |
tags - [String]
|
The list of tags associated with the person. |
addresses - [Address]
|
Retrieves the addresses associated to the person. |
Arguments
|
|
emailAddresses - [EmailAddress]
|
Retrieves the email addresses associated to the person. |
Arguments
|
|
phoneNumbers - [PhoneNumber]
|
Retrieves the phone numbers associated to the person. |
Arguments
|
|
additionalFieldValues - AdditionalFieldValueResults
|
Retrieves the list-specific additional field values for the person. |
Arguments
|
|
contactAdditionalFieldValues - ContactAdditionalFieldValueResults
|
Retrieves the additional field values associated with the person. |
Arguments
|
|
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "abc123",
"contactEntity": "Any",
"notes": Notes,
"visibility": "unknown",
"relationshipScore": Score,
"isEmployee": true,
"isPendingFirmContact": false,
"title": "xyz789",
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "abc123",
"fullName": "xyz789",
"suffix": "abc123",
"goesBy": "abc123",
"currentJobTitle": "xyz789",
"currentEmployer": Company,
"assistantName": "abc123",
"contactTypes": [ContactFolderContactType],
"tags": ["abc123"],
"addresses": [Address],
"emailAddresses": [EmailAddress],
"phoneNumbers": [PhoneNumber],
"additionalFieldValues": AdditionalFieldValueResults,
"contactAdditionalFieldValues": ContactAdditionalFieldValueResults
}
PhoneInput
Description
Input for creating or updating a phone number.
Fields
| Input Field | Description |
|---|---|
id - ID
|
The ID of the phone to update. Can be null for new values. |
owningContactId - ID
|
The ID of the contact that owns this phone. |
number - String
|
The phone number. |
usage - UsageTypes
|
The usage type for this phone. |
phoneType - PhoneNumberTypes
|
The type for this phone. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"owningContactId": "00000006-0002-0000-0000-000000000000",
"number": "abc123",
"usage": "AlternateBusiness",
"phoneType": "Mobile"
}
PhoneNumber
Description
Represents a phone number associated with a contact.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the phone number. |
addressId - ID
|
The ID of the address associated with this phone number. |
number - String
|
The phone number. |
label - String
|
The label of the phone number. |
type - PhoneNumberTypes
|
The type of the phone number (Mobile, Phone, Pager, etc.). |
usage - UsageTypes
|
The usage type of the phone number (AlternateBusiness, AlternateHome, etc.). |
owningContactId - ID
|
The ID of the contact that owns this phone number. |
isGlobal - Boolean
|
Indicates whether this is a global phone number. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"addressId": "00000006-0002-0000-0000-000000000000",
"number": "xyz789",
"label": "xyz789",
"type": "Mobile",
"usage": "AlternateBusiness",
"owningContactId": "00000006-0002-0000-0000-000000000000",
"isGlobal": true
}
PhoneNumberTypes
Description
The available phone number types.
Values
| Enum Value | Description |
|---|---|
|
|
Indicates that the phone number type is a mobile or cell phone. |
|
|
Indicates that the phone number type is a standard phone. |
|
|
Indicates that the phone number type is a pager. |
|
|
Indicates that the phone number type is a fax machine. |
|
|
Indicates that the phone number type is a computer. |
|
|
Indicates that the phone number type is an assistant's phone. |
|
|
Indicates that the phone number type is other than the predefined types. |
Example
"Mobile"
PracticeGroup
PracticeGroupResults
Fields
| Field Name | Description |
|---|---|
totalModels - Int!
|
The total number of items found. |
models - [PracticeGroup]
|
The list of practice groups. |
Example
{"totalModels": 987, "models": [PracticeGroup]}
Profile
Fields
| Field Name | Description |
|---|---|
profileId - ID
|
The ID of the profile. |
name - String
|
The name of the profile. |
displayOrder - Int
|
The display rank of this profile. Profiles are ordered by displayOrder value from lowest to highest. |
listingType - String
|
The type of listing: Company, Person, or Both. |
userCriterionIds - [ID]
|
The list of user IDs who have access to view the profile. |
groupCriterionIds - [ID]
|
Group IDs with access to this profile. Users belonging to any of these groups can view this profile. |
contactTypeIds - [ID]
|
The contact type IDs of the profile. |
profileItems - [ProfileItem]
|
The list of items contained in the profile. |
Example
{
"profileId": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"displayOrder": 987,
"listingType": "xyz789",
"userCriterionIds": [
"00000006-0002-0000-0000-000000000000"
],
"groupCriterionIds": [
"00000006-0002-0000-0000-000000000000"
],
"contactTypeIds": [
"00000006-0002-0000-0000-000000000000"
],
"profileItems": [ProfileItem]
}
ProfileDataType
Description
Represents a profile field data type.
Fields
| Field Name | Description |
|---|---|
dataType - AdditionalFieldDataType
|
The data type of this profile field. |
displayDataType - String
|
The label for this data type to be displayed in this field. |
trueValue - String
|
The label for the true value when the dataType is 'Boolean'. |
falseValue - String
|
The label for the false value when the dataType is 'Boolean'. |
contactTypesAllowed - String
|
Allowed contact types for this profile field: Person, Company, or Both. |
Example
{
"dataType": "integer",
"displayDataType": "abc123",
"trueValue": "abc123",
"falseValue": "xyz789",
"contactTypesAllowed": "abc123"
}
ProfileItem
Description
Represents a profile field.
Fields
| Field Name | Description |
|---|---|
type - FieldType
|
The type of this profile field. |
customFieldId - Long!
|
The custom field ID of this profile field. |
label - String
|
The label of this profile field. |
associatedCompanyValue - Boolean
|
Indicates whether this profile field is associated with a company. |
hideIfEmpty - Boolean
|
Indicates whether this profile field will be hidden if empty. |
summary - Boolean
|
Indicates whether this field should appear in the summary of the profile. |
href - String
|
The URL of the link, if this field is a Link type. |
displayMask - String
|
An edit/display mask for values in this field. |
dataType - ProfileDataType
|
Additional constraints for data stored by this profile field. |
note - FirmNote
|
The note associated with this profile field. |
Example
{
"type": "Heading",
"customFieldId": 10301,
"label": "abc123",
"associatedCompanyValue": false,
"hideIfEmpty": false,
"summary": true,
"href": "xyz789",
"displayMask": "xyz789",
"dataType": ProfileDataType,
"note": FirmNote
}
ProfileResults
RegionalLanguage
Description
Represents a regional language.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"localName": "abc123",
"isoCode": "xyz789"
}
RegionalSetting
Description
Represents a regional setting.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"code": "abc123",
"name": "abc123"
}
RegionalSettings
Description
Represents the regional settings.
Fields
| Field Name | Description |
|---|---|
language - RegionalSetting
|
The language settings of current user. |
country - RegionalSetting
|
The country settings of the current user. |
locale - RegionalSetting
|
The locale settings of the current user. |
languages - [RegionalLanguage]
|
The list of all regional languages. |
Example
{
"language": RegionalSetting,
"country": RegionalSetting,
"locale": RegionalSetting,
"languages": [RegionalLanguage]
}
RemoveCustomFieldResults
Description
Represents the result of removing a custom field.
Fields
| Field Name | Description |
|---|---|
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
item - Boolean
|
Indicates whether the operation was successful. |
Example
{"validationErrors": [ValidationErrors], "item": false}
RemoveCustomFormResults
Description
Represents the result of removing a custom form.
Fields
| Field Name | Description |
|---|---|
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
item - Boolean
|
Indicates whether the operation was successful. |
Example
{"validationErrors": [ValidationErrors], "item": false}
RemoveOpportunityResult
Description
Represents the result of removing an opportunity.
Fields
| Field Name | Description |
|---|---|
isSuccessful - Boolean
|
Indicates whether the operation was successful. |
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
Example
{
"isSuccessful": false,
"validationErrors": [ValidationErrors]
}
ResultCode
Values
| Enum Value | Description |
|---|---|
|
|
Indicates that no change has taken place. |
|
|
Indicates that the change has been accepted. |
|
|
Indicates that the change is under review. |
|
|
Indicates that the change has been submitted for approval. |
Example
"NoChange"
Score
Description
Represents a relationship score — a measure of how strongly the current user is connected to the related person, expressed as a numeric value against its maximum and summarized as a banded strength level.
Fields
| Field Name | Description |
|---|---|
strength - Int!
|
The relationship strength level (a banded rating derived from the score). See value for the underlying numeric score and maxValue for its ceiling. |
value - Int!
|
The numeric relationship score. |
maxValue - Int!
|
The maximum possible value for the relationship score. |
description - String
|
The description of the relationship strength level. |
Example
{
"strength": 123,
"value": 987,
"maxValue": 987,
"description": "abc123"
}
SearchResultsFrom
Values
| Enum Value | Description |
|---|---|
|
|
Results derived from search term. |
|
|
Results derived from email address. |
|
|
Results derived from full name. |
Example
"Term"
SearchTerms
Example
{
"term": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"company": "xyz789",
"emailAddress": "xyz789"
}
Sort
SortDirection
Values
| Enum Value | Description |
|---|---|
|
|
Sorts in ascending order. |
|
|
Sorts in descending order. |
Example
"Ascending"
SortInput
State
Description
Represents a state object. Examples include territories, provinces, or states.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"abbreviation": "xyz789"
}
Status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"open"
String
Example
"abc123"
StringCustomField
Description
Represents a custom field that stores a string value.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the string custom field. |
displayName - String
|
The display name of the string custom field. |
description - String
|
The description of the string custom field. |
required - Boolean
|
Indicates whether the string custom field is required. |
isActive - Boolean
|
Indicates whether the string custom field is active. |
canRemove - Boolean
|
Indicates whether the string custom field can be removed. |
control - CustomFieldControl
|
The control for the string custom field. |
createDate - Date
|
The date the string custom field was created. |
changeDate - Date
|
The date the string custom field was last changed. |
displayOrder - Int
|
The display order of the string custom field. |
maxSize - Int
|
The maximum size of the string value. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "abc123",
"description": "xyz789",
"required": true,
"isActive": true,
"canRemove": false,
"control": CustomFieldControl,
"createDate": "2007-12-03",
"changeDate": "2007-12-03",
"displayOrder": 123,
"maxSize": 987
}
StringFilterInput
Description
Input for filtering by a string value.
Fields
| Input Field | Description |
|---|---|
value - String
|
The value to filter by. |
filterType - StringFilterType
|
The type of string matching to apply. |
Example
{
"value": "abc123",
"filterType": "Contains"
}
StringFilterType
Values
| Enum Value | Description |
|---|---|
|
|
Matches values that contain the specified text. |
|
|
Matches values that are exactly equal to the specified text. |
Example
"Contains"
Unknown
Description
Represents an unknown type of contact.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the contact. |
displayName - String
|
The display name of the contact. |
contactEntity - ContactEntity
|
The entity type of the contact (Person, Company, Any or None). |
notes - Notes
|
The firm notes and 'my' notes about the contact. |
visibility - ContactVisibility
|
The visibility settings of the contact. |
relationshipScore - Score
|
The relationship score of the contact. |
title - String
|
The salutational title of the person (Mr., Mrs., Dr., etc.). |
firstName - String
|
The first name of the person. |
middleName - String
|
The middle name of the person. |
lastName - String
|
The last name of the person. |
fullName - String
|
The full name of the person. |
suffix - String
|
The suffix of the person (Jr., M.D., etc.). |
goesBy - String
|
The preferred name or nickname of the person. |
currentJobTitle - String
|
The current job title of the person. |
currentEmployer - Company
|
The current employer of the person. |
assistantName - String
|
The name of the person's assistant. |
contactTypes - [ContactFolderContactType]
|
The contact types associated with the contact. |
tags - [String]
|
The tags associated with the contact. |
addresses - [Address]
|
Retrieves the addresses associated to the contact. |
Arguments
|
|
emailAddresses - [EmailAddress]
|
Retrieves the email addresses associated to the contact. |
Arguments
|
|
phoneNumbers - [PhoneNumber]
|
Retrieves the phone numbers associated to the contact. |
Arguments
|
|
additionalFieldValues - AdditionalFieldValueResults
|
Retrieves the list-specific additional field values for the contact. |
Arguments
|
|
contactAdditionalFieldValues - ContactAdditionalFieldValueResults
|
Retrieves the additional field values associated with the contact. |
Arguments
|
|
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"displayName": "abc123",
"contactEntity": "Any",
"notes": Notes,
"visibility": "unknown",
"relationshipScore": Score,
"title": "abc123",
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "xyz789",
"fullName": "abc123",
"suffix": "abc123",
"goesBy": "xyz789",
"currentJobTitle": "abc123",
"currentEmployer": Company,
"assistantName": "abc123",
"contactTypes": [ContactFolderContactType],
"tags": ["abc123"],
"addresses": [Address],
"emailAddresses": [EmailAddress],
"phoneNumbers": [PhoneNumber],
"additionalFieldValues": AdditionalFieldValueResults,
"contactAdditionalFieldValues": ContactAdditionalFieldValueResults
}
UpdateContactAdditionalFieldsInput
Description
Input for updating additional fields of a contact.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the contact to update. |
contactAdditionalFields - [AdditionalField]
|
The additional fields to update. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"contactAdditionalFields": [AdditionalField]
}
UpdateCustomFieldInput
Description
Input for updating an existing custom field.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the custom field to update. |
formId - ID!
|
The ID of the parent custom form. |
displayName - String!
|
The display name for the custom field. |
description - String
|
The description for the custom field. |
required - Boolean
|
Indicates whether the custom field is required. |
maxSize - Int
|
The maximum size for the custom field. |
currencyMaxAmount - Decimal
|
The maximum currency amount for the custom field. |
enumInput - CustomFieldEnumInput
|
The enum options for the custom field. |
isActive - Boolean
|
Indicates whether the custom field is active. Default = false |
displayOrder - Int
|
The display order for the custom field. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"formId": "00000006-0002-0000-0000-000000000000",
"displayName": "abc123",
"description": "abc123",
"required": false,
"maxSize": 123,
"currencyMaxAmount": Decimal,
"enumInput": CustomFieldEnumInput,
"isActive": true,
"displayOrder": 123
}
UpdateCustomFieldResults
Description
Represents the result of updating a custom field.
Fields
| Field Name | Description |
|---|---|
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
item - CustomField
|
The updated custom field. |
Example
{
"validationErrors": [ValidationErrors],
"item": CustomField
}
UpdateCustomFormInput
Description
Input for updating an existing custom form.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"isActive": false,
"name": "abc123",
"description": "xyz789"
}
UpdateCustomFormResults
Description
Represents the result of updating a custom form.
Fields
| Field Name | Description |
|---|---|
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
item - CustomForm
|
The updated custom form. |
Example
{
"validationErrors": [ValidationErrors],
"item": CustomForm
}
UpdateCustomStandardFieldInput
Description
Input for updating an existing standard field.
Example
{
"standardFieldId": "00000006-0002-0000-0000-000000000000",
"layoutId": "00000006-0002-0000-0000-000000000000",
"isRequired": true,
"isActive": false
}
UpdateCustomStandardFieldResult
Description
Represents the result of updating a standard field.
Fields
| Field Name | Description |
|---|---|
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
item - Boolean
|
Indicates whether the operation was successful. |
Example
{"validationErrors": [ValidationErrors], "item": true}
UpdateListContactAdditionalFieldInput
Description
Input for updating a list contact's additional fields.
Fields
| Input Field | Description |
|---|---|
contactId - ID!
|
The ID of the contact to update. |
additionalFields - [AdditionalField]!
|
The additional fields to update. |
Example
{
"contactId": "00000006-0002-0000-0000-000000000000",
"additionalFields": [AdditionalField]
}
UpdateListContactAdditionalFieldResults
Example
{
"fieldId": "00000006-0002-0000-0000-000000000000",
"valueId": "00000006-0002-0000-0000-000000000000",
"isSuccessful": true,
"failureReason": "abc123"
}
UpdateObjectResult
Description
Represents the result of updating an object.
Fields
| Field Name | Description |
|---|---|
id - ID
|
The ID of the updated object. |
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"validationErrors": [ValidationErrors]
}
UpdateOpportunityConfidentialInput
Description
Input for updating the confidentiality of an existing opportunity.
Example
{
"opportunityId": "00000006-0002-0000-0000-000000000000",
"isConfidential": false
}
UpdateOpportunityConfidentialResult
Description
Represents the result of updating the confidentiality flag of an opportunity.
Fields
| Field Name | Description |
|---|---|
opportunityId - ID
|
The ID of the updated opportunity. |
isConfidential - Boolean
|
Indicates whether the opportunity is confidential. |
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
Example
{
"opportunityId": "00000006-0002-0000-0000-000000000000",
"isConfidential": false,
"validationErrors": [ValidationErrors]
}
UpdateOpportunityDetailsInput
Description
Input for updating the details of an existing opportunity.
Fields
| Input Field | Description |
|---|---|
opportunityId - ID!
|
The ID of the opportunity to update. |
practiceGroup - ID
|
The ID of the practice group for the opportunity. |
industryType - ID
|
The ID of the industry type for the opportunity. |
estimatedCloseDate - Date
|
The estimated close date for the opportunity. |
originationSourceId - ID
|
The ID of the origination source for the opportunity. |
originationSourceContactId - ID
|
The ID of the origination source contact (referred by) for the opportunity. |
originationSourceCompanyId - ID
|
The ID of the origination source company (referred-by company) for the opportunity. |
practiceGroups - [ID]
|
The list of IDs of the practice groups for the opportunity. |
industries - [ID]
|
The list of IDs of the industries for the opportunity. |
workTypeId - ID
|
The ID of the work type for the opportunity. |
Example
{
"opportunityId": "00000006-0002-0000-0000-000000000000",
"practiceGroup": "00000006-0002-0000-0000-000000000000",
"industryType": "00000006-0002-0000-0000-000000000000",
"estimatedCloseDate": "2007-12-03",
"originationSourceId": "00000006-0002-0000-0000-000000000000",
"originationSourceContactId": "00000006-0002-0000-0000-000000000000",
"originationSourceCompanyId": "00000006-0002-0000-0000-000000000000",
"practiceGroups": [
"00000006-0002-0000-0000-000000000000"
],
"industries": [
"00000006-0002-0000-0000-000000000000"
],
"workTypeId": "00000006-0002-0000-0000-000000000000"
}
UpdateOpportunityLinksInput
Description
Input for updating the links of an existing opportunity.
Fields
| Input Field | Description |
|---|---|
opportunityId - ID!
|
The ID of the opportunity to update. |
opportunityLinks - [OpportunityLinkInput!]
|
The list of links associated with the opportunity. |
Example
{
"opportunityId": "00000006-0002-0000-0000-000000000000",
"opportunityLinks": [OpportunityLinkInput]
}
UpdateOpportunityLocationsInput
Description
Input for updating the locations of an existing opportunity.
Fields
| Input Field | Description |
|---|---|
opportunityId - ID!
|
The ID of the opportunity to update. |
locations - [LocationInput!]
|
The list of locations for the opportunity. |
Example
{
"opportunityId": "00000006-0002-0000-0000-000000000000",
"locations": [LocationInput]
}
UpdateOpportunityOriginationSourceInput
Description
Input for updating an existing opportunity origination source.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the opportunity origination source to update. |
name - String!
|
The name of the opportunity origination source. |
description - String
|
The description of the opportunity origination source. |
isActive - Boolean!
|
Indicates whether the origination source is active. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "xyz789",
"description": "abc123",
"isActive": false
}
UpdateOpportunityOutcomeReasonInput
Description
Input for updating an existing opportunity outcome reason.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the opportunity outcome reason to update. |
outcomeId - ID!
|
The ID of the outcome for this reason. |
name - String!
|
The name of the opportunity outcome reason. |
description - String
|
The description of the opportunity outcome reason. |
isActive - Boolean!
|
Indicates whether the opportunity outcome reason is active. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"outcomeId": "00000006-0002-0000-0000-000000000000",
"name": "xyz789",
"description": "xyz789",
"isActive": false
}
UpdateOpportunityPeopleInput
Description
Input for updating the people associated with an existing opportunity.
Fields
| Input Field | Description |
|---|---|
opportunityId - ID!
|
The ID of the opportunity to update. |
associatedPrincipals - [OpportunityTeamMemberInput!]
|
The list of team members associated with this opportunity. |
associatedContacts - [OpportunityTargetCompanyContactInput!]
|
The list of target company contacts associated with this opportunity. |
Example
{
"opportunityId": "00000006-0002-0000-0000-000000000000",
"associatedPrincipals": [OpportunityTeamMemberInput],
"associatedContacts": [
OpportunityTargetCompanyContactInput
]
}
UpdateOpportunityResult
Description
Represents the result of updating an opportunity.
Fields
| Field Name | Description |
|---|---|
opportunityId - ID!
|
The ID of the updated opportunity. |
Example
{
"opportunityId": "00000006-0002-0000-0000-000000000000"
}
UpdateOpportunityStageInstanceInput
Description
Input for updating the stage instance of an existing opportunity.
Example
{
"opportunityId": "00000006-0002-0000-0000-000000000000",
"stageInstanceId": "00000006-0002-0000-0000-000000000000"
}
UpdateOpportunityStageTemplateInput
UpdateOpportunityStatusInput
Description
Input for updating the status of an existing opportunity.
Fields
| Input Field | Description |
|---|---|
opportunityId - ID!
|
The ID of the opportunity to update. |
actualCloseDate - Date
|
The actual close date for the opportunity. |
actualOutcome - ID
|
The ID of the actual outcome for the opportunity. |
actualOutcomeReason - ID
|
The ID of the actual outcome reason for the opportunity. |
associatedOutcomeReasons - [OpportunityOutcomeMultiselectReason!]
|
The list of outcome reasons associated with the opportunity. |
projectedRevenue - MoneyInput
|
The projected revenue for the opportunity. |
actualRevenue - MoneyInput
|
The actual revenue for the opportunity. |
associatedMatter - String
|
The matter associated with the opportunity. |
dateOpened - Date
|
The date the opportunity was opened. |
Example
{
"opportunityId": "00000006-0002-0000-0000-000000000000",
"actualCloseDate": "2007-12-03",
"actualOutcome": "00000006-0002-0000-0000-000000000000",
"actualOutcomeReason": "00000006-0002-0000-0000-000000000000",
"associatedOutcomeReasons": [
OpportunityOutcomeMultiselectReason
],
"projectedRevenue": MoneyInput,
"actualRevenue": MoneyInput,
"associatedMatter": "abc123",
"dateOpened": "2007-12-03"
}
UpdateOpportunitySummaryInput
Description
Input for updating the summary of an existing opportunity.
Fields
| Input Field | Description |
|---|---|
opportunityId - ID!
|
The ID of the opportunity to update. |
opportunityTypeId - ID!
|
The ID of the opportunity type. |
targetCompanyId - ID!
|
The ID of the target company for the opportunity. |
title - String!
|
The title of the opportunity. |
description - String
|
The description of the opportunity. |
associatedInitiativeId - ID
|
The ID of the initiative associated with the opportunity. |
Example
{
"opportunityId": "00000006-0002-0000-0000-000000000000",
"opportunityTypeId": "00000006-0002-0000-0000-000000000000",
"targetCompanyId": "00000006-0002-0000-0000-000000000000",
"title": "abc123",
"description": "xyz789",
"associatedInitiativeId": "00000006-0002-0000-0000-000000000000"
}
UpdateOpportunityTypeInput
Description
Input for updating an existing opportunity type.
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"name": "abc123",
"description": "abc123",
"isActive": false
}
UpdateOpportunityValidationResult
Description
Represents the validation result of updating an opportunity.
Fields
| Field Name | Description |
|---|---|
item - UpdateOpportunityResult
|
The result of updating the opportunity. |
validationErrors - [ValidationErrors]
|
A collection of validation errors that occurred during the operation. |
Example
{
"item": UpdateOpportunityResult,
"validationErrors": [ValidationErrors]
}
UpdatePublicCompanyInput
Description
Input for updating an existing company firm contact.
Fields
| Input Field | Description |
|---|---|
companyId - ID!
|
The ID of the company to update. |
companyName - String
|
The name for the company. |
alias - String
|
The common name or alias for the company. |
entityId - String
|
The ID for the matching entity. |
entityEmail - String
|
The email address for the matching entity. |
entityCountry - String
|
The country for the matching entity. |
entityCity - String
|
The city for the matching entity. |
entityState - String
|
The state for the matching entity. |
entityWebsite - String
|
The website for the matching entity. |
matchingStrength - Float
|
The match strength of the matching entity. |
folderContactTypes - [ID]
|
A list of ContactType IDs to associate to the company. |
businessAddress - AddressInput
|
The business address for the company. |
primaryPhone - PhoneInput
|
The primary phone number for the company. |
secondaryPhone - PhoneInput
|
The secondary phone number for the company. |
mobilePhone - PhoneInput
|
The mobile phone number for the company. |
faxNumber - PhoneInput
|
The fax number for the company. |
pagerNumber - PhoneInput
|
The pager number for the company. |
businessEmail - ElectronicAddressInput
|
The business email address for the company. |
website - ElectronicAddressInput
|
The website for the company. |
canAutoUpdate - Boolean
|
Indicates whether the company can automatically update. |
Example
{
"companyId": "00000006-0002-0000-0000-000000000000",
"companyName": "xyz789",
"alias": "xyz789",
"entityId": "xyz789",
"entityEmail": "abc123",
"entityCountry": "abc123",
"entityCity": "xyz789",
"entityState": "abc123",
"entityWebsite": "xyz789",
"matchingStrength": 123.45,
"folderContactTypes": [
"00000006-0002-0000-0000-000000000000"
],
"businessAddress": AddressInput,
"primaryPhone": PhoneInput,
"secondaryPhone": PhoneInput,
"mobilePhone": PhoneInput,
"faxNumber": PhoneInput,
"pagerNumber": PhoneInput,
"businessEmail": ElectronicAddressInput,
"website": ElectronicAddressInput,
"canAutoUpdate": false
}
UpdatePublicPersonInput
Description
Input for updating an existing person firm contact.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The ID of the person to update. |
firstName - String
|
The first name for the person. |
lastName - String
|
The last name for the person. |
title - String
|
The salutational title for the person (Mr., Mrs., Dr., etc.). |
suffix - String
|
The suffix for the person (Jr., M.D., etc.). |
middleName - String
|
The middle name for the person. |
goesBy - String
|
The preferred name or nickname for the person. |
primaryPhone - PhoneInput
|
The primary phone number for the person. |
companyPhone - PhoneInput
|
The company phone number for the person. |
faxNumber - PhoneInput
|
The fax number for the person. |
mobilePhone - PhoneInput
|
The mobile phone number for the person. |
pagerNumber - PhoneInput
|
The pager number for the person. |
email - ElectronicAddressInput
|
The email address for the person. |
website - ElectronicAddressInput
|
The website for the person. |
assistantName - String
|
The name of the person's assistant. |
assistantPhone - PhoneInput
|
The phone number of the person's assistant. |
companyName - String
|
The name of the company where the person is employed. |
companyId - ID
|
The ID of the company where the person is employed. |
jobTitle - String
|
The job title for the person. |
address - AddressInput
|
The address for the person. |
folderContactTypes - [ID]
|
A list of ContactType IDs to associate to the person. |
contactAdditionalFields - [AdditionalField]
|
The language and gender settings for the person. You must have language-specific information enabled in firm settings. |
canAutoUpdate - Boolean
|
Indicates whether updates should be applied automatically at the person level. |
Example
{
"id": "00000006-0002-0000-0000-000000000000",
"firstName": "xyz789",
"lastName": "abc123",
"title": "xyz789",
"suffix": "abc123",
"middleName": "abc123",
"goesBy": "xyz789",
"primaryPhone": PhoneInput,
"companyPhone": PhoneInput,
"faxNumber": PhoneInput,
"mobilePhone": PhoneInput,
"pagerNumber": PhoneInput,
"email": ElectronicAddressInput,
"website": ElectronicAddressInput,
"assistantName": "abc123",
"assistantPhone": PhoneInput,
"companyName": "xyz789",
"companyId": "00000006-0002-0000-0000-000000000000",
"jobTitle": "abc123",
"address": AddressInput,
"folderContactTypes": [
"00000006-0002-0000-0000-000000000000"
],
"contactAdditionalFields": [AdditionalField],
"canAutoUpdate": true
}
UsageTypes
Description
The available usage types for addresses, email addresses, and phone numbers.
Values
| Enum Value | Description |
|---|---|
|
|
Indicates that the usage type is an alternate business. |
|
|
Indicates that the usage type is an alternate home. |
|
|
Indicates that the usage type is a primary business. |
|
|
Indicates that the usage type is a home. |
|
|
Indicates that the usage type is a secondary business. |
|
|
Indicates that the usage type is other than the predefined types. |
Example
"AlternateBusiness"