Developers
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

GraphQLTypes indexP

Each type links to the repository page that documents it; the types several repositories share are documented below, with their fields.

A B C D E F G H I J L M N O P Q R S T U V W X Y

PageInfo ParentAccountCardProperty ParentAccountRelationTypeEntity ParentAccountRelationTypeEntityConnection ParentAccountRelationTypeEntityEdge ParentAccountRelationTypeFilterInput ParentAccountRelationTypeOrderByInput ParentAccountRelationTypeOrderByNestedInput ParentAccountRelationTypeRepository PdfOptions PdfOptionsParams PeriodCompareKind PeriodCompareOption PeriodGranularity PeriodKind PeriodOption PeriodOptionParams PersonalizeBodyEmailTemplateInput PersonalizeBodyEmailTemplatePayload PersonificationEntityData PersonificationEntityDataParams PhoneEntity PhoneEntityConnection PhoneEntityEdge PhoneFilterInput PhoneOrderByInput PhoneOrderByNestedInput PhoneRepository PhoneTypeEnum PhoneTypeEnumFilterInput PipelineEntity PipelineEntityConnection PipelineEntityEdge PipelineFilterInput PipelineOrderByInput PipelineOrderByNestedInput PipelineProfileInterface PipelineRepository PivotField PivotReportTabsInterface PivotReportTotal PivotTable PollMessagesInput Position PrimitiveType PrimitiveTypeFilterInput PriorityEnum PriorityEnumFilterInput ProcessActionTypeIconEnum ProcessActivityLogEntity ProcessActivityLogEntityConnection ProcessActivityLogEntityEdge ProcessActivityLogFilterInput ProcessActivityLogLineEntity ProcessActivityLogLineEntityConnection ProcessActivityLogLineEntityEdge ProcessActivityLogLineFilterInput ProcessActivityLogLineOrderByInput ProcessActivityLogLineRepository ProcessActivityLogOrderByInput ProcessActivityLogOrderByNestedInput ProcessActivityLogRepository ProcessActorInterface ProcessArchiveRecordNode ProcessBuilderNotificationSettings ProcessBuilderNotificationSettingsParams ProcessChangeOwnershipAssigneeType ProcessChangeOwnershipNode ProcessCopyRecordNode ProcessCreateRecordNode ProcessCreateRelatedRecordNode ProcessDeactivationReasonEnum ProcessDeactivationReasonEnumFilterInput ProcessEnrollEmailSequenceNode ProcessEntity ProcessEntityConnection ProcessEntityEdge ProcessEntityOperation ProcessEntityOperationEnum ProcessEntityOperationExtras ProcessEntityTemplate ProcessFilterInput ProcessFilterNode ProcessLinkRecordNode ProcessManualTrigger ProcessNodeEmail ProcessNodeEmailSender ProcessNodeInterface ProcessNodeSchedule ProcessNodeScheduleUnitEnum ProcessOnlineFormTrigger ProcessOrderByInput ProcessOrderByNestedInput ProcessQualifyRecordNode ProcessRecordIdentificationType ProcessRecordNodeRelationEnum ProcessRecordTrigger ProcessRecordTriggerActorEnum ProcessRecordTriggerEventEnum ProcessRepository ProcessScheduledActionEntity ProcessScheduledActionEntityConnection ProcessScheduledActionEntityEdge ProcessScheduledActionFilterInput ProcessScheduledActionOrderByInput ProcessScheduledActionRepository ProcessScheduleInterface ProcessScheduleTrigger ProcessSchema ProcessSchemaJSONString ProcessSendEmailNode ProcessSendWebhookNode ProcessStatusEnum ProcessStatusEnumFilterInput ProcessTabDataGridViewOptionsParams ProcessTemplateEntity ProcessTemplateEntityConnection ProcessTemplateEntityEdge ProcessTemplateFilterInput ProcessTemplateOrderByInput ProcessTemplateOrderByNestedInput ProcessTemplateRepository ProcessTimelineItem ProcessTimelineResult ProcessTrigger ProcessTriggerProcessNode ProcessTriggerTypeEnum ProcessTypeEnum ProcessTypeEnumFilterInput ProcessUnarchiveRecordNode ProcessUnenrollEmailSequenceNode ProcessUpdateAiFieldsNode ProcessUpdateRecordNode ProcessUpdateRelatedRecordNode ProcessWebhook ProcessWebhookBasicAuth ProcessWebhookHeader ProcessWebhookRequestFormat ProcessWebhookRequestType ProcessWebhookTimeFormat ProductCategoryEntity ProductCategoryEntityConnection ProductCategoryEntityEdge ProductCategoryFilterInput ProductCategoryOrderByInput ProductCategoryOrderByNestedInput ProductCategoryRepository ProductDataExRelationEntity ProductDataExRelationEntityConnection ProductDataExRelationEntityEdge ProductDataExRelationFilterInput ProductDataExRelationOrderByInput ProductDataExRelationRepository ProductEntity ProductEntityConnection ProductEntityEdge ProductFilterInput ProductFilterTab ProductListTypeEnum ProductOrderByInput ProductOrderByNestedInput ProductPipelineRelationEntity ProductPipelineRelationEntityConnection ProductPipelineRelationEntityEdge ProductPipelineRelationFilterInput ProductPipelineRelationOrderByInput ProductPipelineRelationRepository ProductPipelinesInput ProductPipelinesObject ProductPivotReportProfile ProductPriceListEntity ProductPriceListEntityConnection ProductPriceListEntityEdge ProductPriceListFilterInput ProductPriceListOrderByInput ProductPriceListOrderByNestedInput ProductPriceListPriceAccessEnum ProductPriceListPriceEntity ProductPriceListPriceEntityConnection ProductPriceListPriceEntityEdge ProductPriceListPriceFilterInput ProductPriceListPriceOrderByInput ProductPriceListPriceRepository ProductPriceListPriceSettings ProductPriceListPriceSettingsJSONString ProductPriceListReference ProductPriceListRepository ProductPriceListStatusEnum ProductPriceListTypeEnum ProductPriceListTypeEnumFilterInput ProductPriceProperty ProductProfileInterface ProductRepository ProductSection ProductTableReportProfile ProductTypeEntity ProductTypeEntityConnection ProductTypeEntityEdge ProductTypeFilterInput ProductTypeOrderByInput ProductTypeOrderByNestedInput ProductTypeRepository ProfileEntity ProfileEntityConnection ProfileEntityEdge ProfileFilterBaseInterface ProfileFilterBoxTabInterface ProfileFilterBoxTabsInterface ProfileFilterInput ProfileFilterTab ProfileFilterTabCustomFilterInterface ProfileOrderByInput ProfileOrderByNestedInput ProfileRelationEntity ProfileRelationEntityConnection ProfileRelationEntityEdge ProfileRelationFilterInput ProfileRelationOrderByInput ProfileRelationRepository ProfileRepository ProfileShareMode ProfileSharingClientRelationEntity ProfileSharingClientRelationEntityConnection ProfileSharingClientRelationEntityEdge ProfileSharingClientRelationFilterInput ProfileSharingClientRelationOrderByInput ProfileSharingClientRelationRepository ProfileSharingSalesUnitRelationEntity ProfileSharingSalesUnitRelationEntityConnection ProfileSharingSalesUnitRelationEntityEdge ProfileSharingSalesUnitRelationFilterInput ProfileSharingSalesUnitRelationOrderByInput ProfileSharingSalesUnitRelationRepository ProfileTabsInterface ProfileTypeEnum ProfileTypeEnumFilterInput ProjectAccountCardProperty ProjectContactCardProperty ProjectContactRelationEntity ProjectContactRelationEntityConnection ProjectContactRelationEntityEdge ProjectContactRelationFilterInput ProjectContactRelationOrderByInput ProjectContactRelationRepository ProjectData ProjectDataExRelationEntity ProjectDataExRelationEntityConnection ProjectDataExRelationEntityEdge ProjectDataExRelationFilterInput ProjectDataExRelationOrderByInput ProjectDataExRelationRepository ProjectEntity ProjectEntityConnection ProjectEntityEdge ProjectFilterInput ProjectFilterTab ProjectKPIEntity ProjectKPIEntityConnection ProjectKPIEntityEdge ProjectKpiEnum ProjectKpiEnumFilterInput ProjectKPIFilterInput ProjectKPIOrderByInput ProjectKPIRepository ProjectObjectiveData ProjectObjectiveEntity ProjectObjectiveEntityConnection ProjectObjectiveEntityEdge ProjectObjectiveFilterInput ProjectObjectiveOrderByInput ProjectObjectiveOrderByNestedInput ProjectObjectiveRepository ProjectObjectiveStatusEnum ProjectOrderByInput ProjectOrderByNestedInput ProjectPivotReportProfile ProjectProfileInterface ProjectRepository ProjectRoleTab ProjectSharingClientRelationEntity ProjectSharingClientRelationEntityConnection ProjectSharingClientRelationEntityEdge ProjectSharingClientRelationFilterInput ProjectSharingClientRelationOrderByInput ProjectSharingClientRelationRepository ProjectSharingSalesUnitRelationEntity ProjectSharingSalesUnitRelationEntityConnection ProjectSharingSalesUnitRelationEntityEdge ProjectSharingSalesUnitRelationFilterInput ProjectSharingSalesUnitRelationOrderByInput ProjectSharingSalesUnitRelationRepository ProjectsNotificationSettings ProjectsNotificationSettingsParams ProjectStatusEnum ProjectStatusEnumFilterInput ProjectTableReportProfile ProjectTypeEntity ProjectTypeEntityConnection ProjectTypeEntityEdge ProjectTypeFilterInput ProjectTypeIconEnum ProjectTypeIconEnumFilterInput ProjectTypeOrderByInput ProjectTypeOrderByNestedInput ProjectTypeRepository

Shared types: P

Types several repositories use, or none does, with their fields and their descriptions.

PageInfo object hasNextPage: Boolean!, hasPreviousPage: Boolean!, startCursor: String, endCursor: String

The Relay compliant PageInfo type, containing data necessary to paginate this connection.

FieldTypeDescription
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringWhen paginating backwards, the cursor to continue.
endCursorStringWhen paginating forwards, the cursor to continue.
ParentAccountRelationTypeRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ParentAccountRelationType records.

FieldTypeDescription
getByIdParentAccountRelationTypeEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ParentAccountRelationTypeEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ParentAccountRelationTypeEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaParentAccountRelationTypeEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
PeriodGranularity enum Day, Week, Month, Quarter, Year

Length of the time bucket each data point of a trend chart represents.

ValueDescription
DayEach data point covers one day.
WeekEach data point covers one week.
MonthEach data point covers one month.
QuarterEach data point covers one quarter.
YearEach data point covers one year.
PeriodKind enum Custom, YearPrevious, YearCurrent, YearNext, Year3Last, WeekPrevious, … (41 values)

Relative or custom date range a report, dashboard or filter is evaluated over; relative ranges are computed from the current user's today, the space's first day of week and its financial year start.

ValueDescription
CustomExplicit range given by periodCustomFrom and periodCustomTo.
YearPreviousThe previous calendar year.
YearCurrentThe current calendar year.
YearNextThe next calendar year.
Year3LastThe current calendar year and the two years before it (from 1 January two years ago to 31 December this year).
WeekPreviousThe previous week, starting on the space's first day of week.
WeekCurrentThe current week, starting on the space's first day of week.
WeekNextThe next week, starting on the space's first day of week.
Week2LastThe previous week and the current week together (two full weeks ending on the last day of the current week).
Week4LastThe current week and the three weeks before it (four full weeks ending on the last day of the current week).
FinancialYearPreviousThe previous financial year, based on the space's financial year start.
FinancialYearCurrentThe current financial year, based on the space's financial year start.
FinancialYearNextThe next financial year, based on the space's financial year start.
FinancialYearQuarter1The first quarter of the current financial year.
FinancialYearQuarter2The second quarter of the current financial year.
FinancialYearQuarter3The third quarter of the current financial year.
FinancialYearQuarter4The fourth quarter of the current financial year.
Quarter1January to March of the current calendar year.
Quarter2April to June of the current calendar year.
Quarter3July to September of the current calendar year.
Quarter4October to December of the current calendar year.
QuarterPreviousThe calendar quarter before the current one.
QuarterCurrentThe current calendar quarter.
QuarterNextThe calendar quarter after the current one.
QuarterCurrentInPreviousYearThe current calendar quarter of the previous year.
Quarter4PreviousThe current calendar quarter and the three quarters before it (the last four quarters including the current one).
MonthPreviousThe previous calendar month.
MonthCurrentThe current calendar month.
MonthNextThe next calendar month.
MonthCurrentInPreviousYearThe current calendar month of the previous year.
Month3LastThe current calendar month and the two months before it.
TodayToday only.
TomorrowTomorrow only.
YesterdayYesterday only.
UpToTodayEverything up to and including today, with no start date.
Days30PreviousThe last 30 days, ending with and including today.
Days30NextThe next 30 days, starting with and including today.
Days7NextThe next 7 days, starting with and including today.
Days14NextThe next 14 days, starting with and including today.
Days7PreviousThe last 7 days, ending with and including today.
AllNo date restriction; all records match.
PeriodOption object periodCustomFrom: Date, periodCustomTo: Date, period: PeriodKind!

Time period used by reports, dashboards and targets: a predefined range such as the current month, or a custom date range.

FieldTypeDescription
periodCustomFromDateSet only if period set to Custom
periodCustomToDateSet only if period set to Custom
periodPeriodKind!Time range the data is reported over (for example MonthCurrent, QuarterCurrent, Custom). When Custom, periodCustomFrom and periodCustomTo define the bounds.
PeriodOptionParams input periodCustomFrom: Date, periodCustomTo: Date, period: PeriodKind!

Time period used by reports, dashboards and targets: a predefined range such as the current month, or a custom date range.

Input fieldTypeDescription
periodCustomFromDateSet only if period set to Custom
periodCustomToDateSet only if period set to Custom
periodPeriodKind!Time range the data is reported over (for example MonthCurrent, QuarterCurrent, Custom). When Custom, periodCustomFrom and periodCustomTo define the bounds.
PhoneOrderByNestedInput input 12 fields: id, isDeleted, modified, …

Sorting by a field of the related Phone record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
errorCodeOrderByEnumError code recorded for the phone, set on integration failures (e.g. provider rejected the last send) or when the user disables the integration; empty when the phone is healthy.
nameOrderByEnumName of the entity and its default text representation.
ownerIdOrderByEnumId of the assigned user, or empty when the phone is a company-level resource.
phoneNumberOrderByEnumPhone number in E.164 format (e.g. "+12025550123").
twilioCallerSidOrderByEnumExternal caller identifier from the calling provider (e.g. Twilio caller SID).
typeOrderByEnumChannel and assignment of the phone number: calling only, calling and SMS (unassigned, personal to the owner or shared by the company), or a personal or company WhatsApp account.
revisionOrderByEnumRevision when entity was lastly changed.
enabledOrderByEnumFalse when the user has disabled the calling/SMS integration on this phone (errorCode is set to indicate user disablement); true otherwise.
PhoneRepository object 7 fields: getById, getByIds, getAll, …

Read operations for Phone records.

FieldTypeDescription
getByIdPhoneEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[PhoneEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[PhoneEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaPhoneEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
getAllForAdmin[PhoneEntity!]! (5 args)Returns all phone numbers of the space, including other users' numbers, for administration.
checkForUnsubscribed[SendTextMessageRecipient!]! (1 args)Returns the recipients from the given list who have unsubscribed from text messages, so they can be removed before sending.
PipelineOrderByNestedInput input 7 fields: id, isDeleted, modified, …

Sorting by a field of the related Pipeline record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
colorOrderByEnumDisplay color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue.
nameOrderByEnumName of the entity and its default text representation.
revisionOrderByEnumRevision when entity was lastly changed.
PipelineRepository object 6 fields: getById, getByIds, getAll, …

Read operations for Pipeline records.

FieldTypeDescription
getByIdPipelineEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[PipelineEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[PipelineEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaPipelineEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
getDefaultPipelinePipelineEntity!Returns the default pipeline of the space.
PollMessagesInput input id: ID!, since: DateTime

Request for the messages of a text message conversation added or changed since a given time.

Input fieldTypeDescription
idID!Id of the conversation to poll.
sinceDateTimeTime after which added or changed messages are returned. Always set it: without it no messages are returned.
Position object x: Int!, y: Int!

A point on a canvas/grid, in integer grid units.

FieldTypeDescription
xInt!Horizontal position from the left edge.
yInt!Vertical position from the top edge.
ProcessActivityLogLineRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProcessActivityLogLine records.

FieldTypeDescription
getByIdProcessActivityLogLineEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProcessActivityLogLineEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProcessActivityLogLineEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProcessActivityLogLineEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProcessActivityLogRepository object 6 fields: getById, getByIds, getAll, …

Read operations for ProcessActivityLog records.

FieldTypeDescription
getByIdProcessActivityLogEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProcessActivityLogEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProcessActivityLogEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProcessActivityLogEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
getDownloadUrlString! (4 args)Exports the activity log of a process to a zipped text file and returns a URL to download it.
ProcessNodeEmail object 14 fields: recipients, cc, bcc, …

Email sent by an automation step: recipients, content, sender and the records it is linked to.

FieldTypeDescription
recipients[SendEmailRecipient!]!Primary recipients of the email. Addresses may contain personalization tags resolved from the triggered record.
cc[SendEmailRecipient!]!Carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record.
bcc[SendEmailRecipient!]!Blind carbon-copy recipients of the email. Addresses may contain personalization tags resolved from the triggered record.
subjectString!Subject line of the email. May contain personalization tags resolved from the triggered record.
bodyString!HTML body of the email. May contain personalization tags resolved from the triggered record.
emailTemplateIdUUIDEmail template to use for the message. When set, the template supplies the subject and body.
attachments[UUID!]!Stored files attached to the email.
signatureStringSignature appended to the email body.
senderProcessNodeEmailSender!Account the email is sent from: the trigger actor, a company email, the record owner, or the approver.
senderCompanyEmailIdUUIDCompany email account to send from. Set when the sender is a company email.
shareModeShareModeEnumVisibility of the sent email to other users in the space.
linkTriggerEntityBooleanWhen true, link the sent email to the triggered record.
linkRecipientsBooleanWhen true, link the sent email to the account and contact records matching the recipient addresses.
isHtmlTemplateBooleanWhether the email body is treated as HTML rather than plain text.
ProcessNodeEmailSender enum ActorEmail, CompanyEmail, RecordOwnerEmail, ApproverEmail

Mailbox a process email action sends from.

ValueDescription
ActorEmailThe user whose action triggered the process.
CompanyEmailA shared company email account.
RecordOwnerEmailThe owner of the triggered record.
ApproverEmailThe approver; available only in approval processes.
ProcessOnlineFormTrigger object 5 fields: entityType, entityApiName, recordType, …

Trigger that starts a process when an online form is submitted.

FieldTypeDescription
entityTypeEntityNameEnum!Type of record whose changes start this process, such as Lead, Opportunity, Account or Contact.
entityApiNameStringAPI name of the custom entity that starts this process. Set only when the trigger entity type is a custom entity.
recordTypeEntityNameEnum!Type of record the online form submission creates, such as Lead or Contact.
recordApiNameStringAPI name of the custom entity the online form submission creates. Set only when the created record type is a custom entity.
onlineForms[UUID!]!Online form types whose submissions start this process.
ProcessOrderByNestedInput input 19 fields: id, isDeleted, modified, …

Sorting by a field of the related Process record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
deactivationReasonOrderByEnumWhy the process is disabled: turned off by a user, suspended after repeated failed runs, or suspended because Automatizer was switched off for the space. NoReason while enabled; read-only.
descriptionOrderByEnumFree-text description shown alongside the process.
isEnabledOrderByEnumWhen true, the process actively responds to its trigger; when false, the process is paused. Toggle via enable/disable mutations.
lastSchemaChangeOrderByEnumTimestamp of the most recent change to settings.
lastStatusChangeOrderByEnumTimestamp of the most recent change to isEnabled.
nameOrderByEnumName of the entity and its default text representation.
ownerIdOrderByEnumId of the owning user.
typeOrderByEnumScope of the process: Personal processes belong to their owner and are started only by the owner's own actions; Space processes apply to the whole space.
lastProcessRunOrderByEnumTimestamp of the most recent execution of this process. Empty when never run.
solutionsOrderByEnumNames of the solutions whose canvas contains this process, in name order. Empty when the process is on no solution canvas.
statusOrderByEnumOverall status of the process, derived from its most recent runs since it was last enabled or its settings changed: Ok, Warning or Error. Ok when there are no runs.
recordTriggerEventOrderByEnumFor record-triggered processes, the event that starts the process: Create, Update, CreateOrUpdate or Delete, or EmailSent / EmailReceived for email-triggered processes. Empty for other trigger types.
triggerTypeOrderByEnumWhat starts the process: a record event (ProcessRecordTrigger), a schedule (ProcessScheduleTrigger), a user on selected records (ProcessManualTrigger) or an online form submission (ProcessOnlineFormTrigger).
triggerEntityNameOrderByEnumFor record-based triggers, the entity whose records fire the process (e.g. "Lead"). Empty for non-record triggers.
triggerEntityApiNameOrderByEnumAPI name of the trigger entity (useful for custom entities where this differs from triggerEntityName). Empty for non-record triggers.
ProcessRecordNodeRelationEnum enum Task, Appointment, Account, Contact, Lead, Opportunity, … (25 values)

Which record a process action or trigger works with: a record of an entity, or records reached from the triggered record through a relation, primary link, parent account or lookup field.

ValueDescription
TaskA task: a new task, the triggered task, or the tasks related to the triggered record, depending on the action.
AppointmentAn appointment: a new appointment, the triggered appointment, or the appointments related to the triggered record, depending on the action.
AccountAn account: a new account, the triggered account, or the accounts related to the triggered record (child accounts for an account), depending on the action.
ContactA contact: a new contact, the triggered contact, or the contacts related to the triggered record, depending on the action.
LeadA lead: a new lead, the triggered lead, or the leads related to the triggered record, depending on the action.
OpportunityAn opportunity: a new opportunity, the triggered opportunity, or the opportunities related to the triggered record, depending on the action.
OpptyProductRelationA product line item of an opportunity: a new one, the triggered one, or the line items of the triggered record, depending on the action.
ProjectA project: a new project, the triggered project, or the project related to the triggered record, depending on the action.
QuoteA quote: a new quote, the triggered quote, or all quotes related to the triggered record, depending on the action.
ActiveQuoteThe active quote of the triggered opportunity.
OnlineFormThe submitted online form response that triggered the process.
CustomEntityA custom entity record: a new one, the triggered one, or the records related to the triggered record, depending on the action.
EmailThe triggered email.
ParentAccountThe parent account of the triggered account; a created parent account replaces any existing one.
ParentAccountNoReplaceCreates a parent account for the triggered account only when it has none yet.
PrimaryAccountThe primary account of the triggered record.
PrimaryContactThe primary contact of the triggered record.
PrimaryInLeadLeads in which the triggered account or contact is set as primary.
PrimaryInOpportunityOpportunities in which the triggered account or contact is set as primary.
PrimaryInContactContacts in which the triggered account is set as the primary account.
PrimaryInQuoteQuotes in which the triggered account or contact is set as primary.
LookupRecords that the triggered record references through the lookup field set in relationLookupFieldId.
LookupRelatedRecords that reference the triggered record through the lookup field set in relationLookupFieldId.
PrimaryLookupOnly the primary record that the triggered record references through the lookup field set in relationLookupFieldId.
PrimaryLookupRelatedOnly the primary record among those referencing the triggered record through the lookup field set in relationLookupFieldId.
ProcessRepository object 12 fields: getById, getByIds, getAll, …

Read operations for Process records.

FieldTypeDescription
getByIdProcessEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProcessEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProcessEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProcessEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
getActivityTimelineProcessTimelineResult! (2 args)Returns how many runs of the process succeeded, ended with a warning or failed, bucketed by hour for the last 24 hours or by day for the last 7 or 14 days, in the user's time zone. Buckets without runs are included with zero counts.
getByProcessCriteriaProcessEntityConnection (7 args)Returns a page of processes filtered by owner, enabled state, status and tags, in addition to the regular filter.
getProcessesWithScheduledActions[ProcessEntity!]! (1 args)Returns the processes that have actions scheduled to run later for any of the selected records.
getTriggeringProcesses[ProcessEntity!]! (1 args)Returns the processes that start the given process from one of their steps.
getRecentExecutions[RecentExecutionItem!]! (3 args)Returns the most recent process runs that involved the record, either because the record triggered the process or because a process action created or changed it, newest first.
getProcessesWithManualTrigger[ProcessEntity!]! (4 args)Returns processes with a manual trigger that the current user is allowed to start, according to each trigger's allowed users and units.
convertProcessSchemasToDescriptions[String!]! (1 args)Converts process definitions into human-readable text descriptions, one per input, in the same order. An empty definition gives an empty string and an invalid one gives the text "error".
ProcessScheduledActionRepository object getById: ProcessScheduledActionEntity, getByIds: [ProcessScheduledActionEntity!]!, getAll: [ProcessScheduledActionEntity!]!, getByCriteria: ProcessScheduledActionEntityConnection

Read operations for ProcessScheduledAction records.

FieldTypeDescription
getByIdProcessScheduledActionEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProcessScheduledActionEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProcessScheduledActionEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProcessScheduledActionEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
ProcessSchema object timezone: String, trigger: ProcessTrigger!, nodes: [ProcessNodeInterface!]!

Definition of an automation process: what starts it and the tree of conditions and actions it runs.

FieldTypeDescription
timezoneStringTimezone used to evaluate the process's scheduled steps.
triggerProcessTrigger!What starts the process — a record event, schedule, or manual launch.
nodes[ProcessNodeInterface!]!Ordered tree of process steps (conditions and actions).
ProcessSchemaJSONString scalar scalar

JSON object, sent as a string, conforming to the ProcessSchema type.

ProcessStatusEnum enum Ok, Warning, Error, Scheduled, Expired

Result of a process, email sequence or approval run or step, or the overall status derived from recent runs.

ValueDescription
OkCompleted successfully.
WarningCompleted with warnings, such as skipped records, or a scheduled step was canceled.
ErrorFailed.
ScheduledNot active yet; its active-from date is in the future.
ExpiredNo longer active; its active-to date has passed.
ProcessStatusEnumFilterInput input eq: [ProcessStatusEnum!], NOT: ProcessStatusEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[ProcessStatusEnum!]Matches any of the listed values.
NOTProcessStatusEnumFilterInputMatches values that do not meet this condition.
ProcessTabDataGridViewOptionsParams input 5 fields: filterByOwnerId, showActive, showInactive, …

Filters for listing processes by owner, active state, status and tags.

Input fieldTypeDescription
filterByOwnerId[ID!]Ids of the owners whose records are listed; null or an empty list turns the owner filter off.
showActiveBoolean!When true, the list includes active records. When both showActive and showInactive are false, the list is not filtered by state.
showInactiveBoolean!When true, the list includes inactive records; see showActive.
filterByStatus[ProcessStatusEnum!]Statuses to include, such as Ok, Warning or Error; null or an empty list turns the status filter off. Ignored when both showActive and showInactive are false.
filterByTagIds[ID!]Ids of tags; only records with at least one of them are listed. Null or an empty list turns the tag filter off. Only processes can be tagged, so for approval processes and email sequences any tag id returns an empty list.
ProcessTemplateRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProcessTemplate records.

FieldTypeDescription
getByIdProcessTemplateEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProcessTemplateEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProcessTemplateEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProcessTemplateEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProcessTrigger union ProcessRecordTrigger | ProcessScheduleTrigger | ProcessManualTrigger | ProcessOnlineFormTrigger

What starts an automation process: a change of a record, a schedule, a manual start or an online form submission.

ProcessTriggerTypeEnum enum ProcessRecordTrigger, ProcessScheduleTrigger, ProcessManualTrigger, ProcessOnlineFormTrigger

What starts an Automatizer process.

ValueDescription
ProcessRecordTriggerA record event, such as create, update or delete.
ProcessScheduleTriggerA schedule.
ProcessManualTriggerA user starting it manually on selected records.
ProcessOnlineFormTriggerAn online form submission.
ProcessTypeEnum enum Personal, Space

Scope of an Automatizer process.

ValueDescription
PersonalOwned by one user and started only by that user's own actions.
SpaceShared for the whole space; its trigger decides whose actions start it.
ProcessTypeEnumFilterInput input eq: [ProcessTypeEnum!], NOT: ProcessTypeEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[ProcessTypeEnum!]Matches any of the listed values.
NOTProcessTypeEnumFilterInputMatches values that do not meet this condition.
ProductCategoryOrderByNestedInput input 7 fields: id, isDeleted, modified, …

Sorting by a field of the related ProductCategory record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
nameOrderByEnumName of the entity and its default text representation.
parentIdOrderByEnumId of the parent category.
revisionOrderByEnumRevision when entity was lastly changed.
ProductCategoryRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProductCategory records.

FieldTypeDescription
getByIdProductCategoryEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProductCategoryEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProductCategoryEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProductCategoryEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProductDataExRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProductDataExRelation records.

FieldTypeDescription
getByIdProductDataExRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProductDataExRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProductDataExRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProductDataExRelationEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProductOrderByNestedInput input 13 fields: id, isDeleted, modified, …

Sorting by a field of the related Product record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
currencyExchangeRatesListIdOrderByEnumId of the currency exchange rate list applied to this product.
descriptionOrderByEnumFree-form description of the product.
nameOrderByEnumName of the product, shown in catalogues and pickers.
productCategoryIdOrderByEnumId of the product category this product belongs to, or empty when it is not categorized.
productTypeIdOrderByEnumId of the product type that classifies this product.
skuOrderByEnumStock-keeping unit (SKU) identifier of the product. Must be unique across products.
unitSymbolOrderByEnumUnit of measure shown next to product quantities (e.g. pcs, kg, hours).
revisionOrderByEnumRevision when entity was lastly changed.
withCustomCommonEntityRepositoryOrderByCustomFieldSorts by a custom field.
ProductPipelineRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProductPipelineRelation records.

FieldTypeDescription
getByIdProductPipelineRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProductPipelineRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProductPipelineRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProductPipelineRelationEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProductPriceListOrderByNestedInput input 12 fields: id, isDeleted, modified, …

Sorting by a field of the related ProductPriceList record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
descriptionOrderByEnumFree-form description of the price list.
endDateOrderByEnumDate when the price list expires. Empty means open-ended.
isActiveOrderByEnumMaster switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates.
nameOrderByEnumName of the entity and its default text representation.
startDateOrderByEnumDate when the price list becomes active. Empty means immediately.
typeOrderByEnumKind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled).
revisionOrderByEnumRevision when entity was lastly changed.
isDefaultOrderByEnumTrue for the team space default price list, which cannot be deleted. Read-only.
ProductPriceListPriceRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProductPriceListPrice records.

FieldTypeDescription
getByIdProductPriceListPriceEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProductPriceListPriceEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProductPriceListPriceEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProductPriceListPriceEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProductPriceListPriceSettingsJSONString scalar scalar

JSON object, sent as a string, conforming to the ProductPriceListPriceSettings type.

ProductPriceListRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProductPriceList records.

FieldTypeDescription
getByIdProductPriceListEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProductPriceListEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProductPriceListEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProductPriceListEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProductRepository object 8 fields: getById, getByIds, getAll, …

Read operations for Product records.

FieldTypeDescription
getByIdProductEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProductEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProductEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProductEntityConnection (8 args)Returns the products that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
getBySessionProductEntityConnection (7 args)Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids.
getByIdFormattedJSONString (2 args)Returns the values of a record's fields formatted for display, keyed by field id.
getForPipeline[ProductEntity!]! (5 args)Returns the products that can be used in the given pipeline: products allowed in all pipelines and products assigned to this pipeline.
ProductSection object id: ID!, name: String!

Section that groups the product lines of an opportunity or quote.

FieldTypeDescription
idID!Unique id of the product section.
nameString!Display name of the product section.
ProductTypeOrderByNestedInput input 9 fields: id, isDeleted, modified, …

Sorting by a field of the related ProductType record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
isReadonlyOrderByEnumTrue when the product type is system-managed and cannot be edited or deleted by users.
nameOrderByEnumName of the entity and its default text representation.
opptyProductRelationTypeIdOrderByEnumId of the paired opportunity/quote line-item type.
isPublishedOrderByEnumTrue when the entity configuration is published; false while it exists only as an unpublished draft.
revisionOrderByEnumRevision when entity was lastly changed.
ProductTypeRepository object 7 fields: getById, getByIds, getAll, …

Read operations for ProductType records.

FieldTypeDescription
getByIdProductTypeEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProductTypeEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProductTypeEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProductTypeEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getPublished[ProductTypeEntity!]! (5 args)Returns the published records that match the filter, paged with limit and offset.
getDrafts[ProductTypeEntity!]! (2 args)Returns the records that match the filter, with pending unpublished changes applied where a draft exists.
getDraftByIdProductTypeEntity! (1 args)Returns the record with the given id, with its pending unpublished changes applied when a draft exists.
ProfileFilterBaseInterface interface isEnabled: Boolean!

Filter of a saved profile, report or dashboard; every variant can be switched on or off.

FieldTypeDescription
isEnabledBoolean!Whether the filter is applied. When false, the filter conditions are ignored.
ProfileFilterBoxTabInterface interface isEnabled: Boolean!, filterMainBox: MainFilterBox!, filterSiblingBoxes: [FilterBox!]!

Filter built from filter boxes: a main box on the record type and boxes on related records.

FieldTypeDescription
isEnabledBoolean!Whether the filter is applied. When false, the filter conditions are ignored.
filterMainBoxMainFilterBox!Primary group of filter conditions evaluated on the main record type.
filterSiblingBoxes[FilterBox!]!Additional groups of filter conditions evaluated on related record types.
ProfileFilterTabCustomFilterInterface interface isCustom: Boolean!, operator: FilterGroupOperator!, formula: String

How the conditions of a filter are combined: all of them (And), any of them (Or) or a custom formula.

FieldTypeDescription
isCustomBoolean!True when the conditions are combined with a custom formula rather than a simple And/Or across all conditions.
operatorFilterGroupOperator!How the conditions are combined: And applies all conditions, Or applies any, Custom evaluates the expression in the formula.
formulaStringBoolean expression combining the numbered conditions (for example "1 AND (2 OR 3)"). Used when the operator is Custom.
ProfileOrderByNestedInput input 13 fields: id, isDeleted, modified, …

Sorting by a field of the related Profile record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
entityOrderByEnumApplication screen the profile (saved view) belongs to, such as the leads, accounts or opportunities screen. For custom entity screens, entityApiName identifies the custom entity.
entityApiNameOrderByEnumAPI name of the custom entity this profile applies to. Set only when the profile targets a custom entity screen; otherwise empty.
nameOrderByEnumName of the entity and its default text representation.
ownerIdOrderByEnumId of the owning user.
shareModeOrderByEnumWho besides the owner can use the profile: nobody (Private), selected users and sales units (Standard), or all users.
syncEnabledOrderByEnumWhen true, changes to the profile are propagated to records linked via ProfileRelation; when false, the profile is detached from the records.
syncEntityIdOrderByEnumId of the synchronized record.
useLangOrderByEnumWhen true, the profile name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
revisionOrderByEnumRevision when entity was lastly changed.
ProfileRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProfileRelation records.

FieldTypeDescription
getByIdProfileRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProfileRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProfileRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProfileRelationEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProfileRepository object 8 fields: getById, getByIds, getAll, …

Read operations for Profile records.

FieldTypeDescription
getByIdProfileEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProfileEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProfileEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProfileEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
getStaticProfilesForAdmin[DefaultProfileEntity!]!Returns the built-in default screen profiles of every screen, including one set per custom entity, for administration.
getProfilesForAdminByIds[ProfileEntity!]! (2 args)Returns the screen profiles with the given ids for administration, regardless of their owner. Built-in default profiles are not included.
getProfilesInAdminProfileEntityConnection (6 args)Returns a page of screen profiles shared with everyone for the given screen, for administration. Built-in default profiles are not included.
ProfileSharingClientRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProfileSharingClientRelation records.

FieldTypeDescription
getByIdProfileSharingClientRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProfileSharingClientRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProfileSharingClientRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProfileSharingClientRelationEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProfileSharingSalesUnitRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProfileSharingSalesUnitRelation records.

FieldTypeDescription
getByIdProfileSharingSalesUnitRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProfileSharingSalesUnitRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProfileSharingSalesUnitRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProfileSharingSalesUnitRelationEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProjectContactRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProjectContactRelation records.

FieldTypeDescription
getByIdProjectContactRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProjectContactRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProjectContactRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProjectContactRelationEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProjectData object project: ProjectEntity!, objectivesCompleted: Int!, objectivesTotal: Int!

Project in a dashboard list, with the progress of its objectives.

FieldTypeDescription
projectProjectEntity!Project shown in the dashboard list; its objective progress is in objectivesCompleted and objectivesTotal.
objectivesCompletedInt!Number of completed objectives of the project.
objectivesTotalInt!Total number of objectives of the project.
ProjectDataExRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProjectDataExRelation records.

FieldTypeDescription
getByIdProjectDataExRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProjectDataExRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProjectDataExRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProjectDataExRelationEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProjectKPIRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProjectKPI records.

FieldTypeDescription
getByIdProjectKPIEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProjectKPIEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProjectKPIEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProjectKPIEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProjectObjectiveData object 10 fields: objective, status, total, …

Project objective in a dashboard list, with the progress of its activities.

FieldTypeDescription
objectiveProjectObjectiveEntityThe objective; null for the activities not assigned to any objective.
statusProjectObjectiveStatusEnumProgress status of the objective, derived from its activities.
totalInt!Number of activities of the objective that the tab lists, after its filters.
completedTotalInt!Number of completed activities of the objective.
inProgressTotalInt!Number of activities of the objective that are in progress, deferred or waiting and not overdue.
overdueTotalInt!Number of overdue activities of the objective.
firstActivityStartDateDateEarliest start date among the listed activities of the objective.
lastActivityEndDateDateLatest due or end date among the listed activities of the objective.
objectiveTotalInt!Total number of activities of the objective the user can see, regardless of the tab filters.
nextPlannedActivityStartDateDateEarliest future start date among the listed activities that are not completed or deferred.
ProjectObjectiveRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProjectObjective records.

FieldTypeDescription
getByIdProjectObjectiveEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProjectObjectiveEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProjectObjectiveEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProjectObjectiveEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProjectObjectiveStatusEnum enum NotStarted, InProgress, AtRisk, Completed

Status of a project objective, derived from its activities.

ValueDescription
NotStartedNone of the objective's activities has started.
InProgressSome of the objective's activities are started or completed.
AtRiskAt least one of the objective's activities is overdue.
CompletedAll of the objective's activities are completed.
ProjectOrderByNestedInput input 19 fields: id, isDeleted, modified, …

Sorting by a field of the related Project record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
accountIdOrderByEnumId of the related account.
currencyExchangeRatesListIdOrderByEnumId of the currency exchange rate list applied to this project.
descriptionOrderByEnumFree-form description of the project.
endDateOrderByEnumPlanned end date of the project. Must be on or after startDate when both are set.
nameOrderByEnumName of the entity and its default text representation.
ownerIdOrderByEnumId of the project owner.
projectTypeIdOrderByEnumId of the project type that classifies this project.
shareModeOrderByEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users).
startDateOrderByEnumDate when the project starts.
unitIdOrderByEnumId of the sales unit.
revisionOrderByEnumRevision when entity was lastly changed.
revenueGoalOrderByEnumTarget revenue of the project, stored in the team space base currency with the foreign value and currency code preserved alongside.
enrolledEmailSequencesOrderByEnumNumber of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted).
statusOrderByEnumCurrent status of the project (NotStarted, InProgress, Completed). Read-only; derived from is_completed and the underlying activity progress.
withCustomCommonEntityRepositoryOrderByCustomFieldSorts by a custom field.
ProjectRepository object 8 fields: getById, getByIds, getAll, …

Read operations for Project records.

FieldTypeDescription
getByIdProjectEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProjectEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProjectEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProjectEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
getBySessionProjectEntityConnection (7 args)Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids.
getByIdFormattedJSONString (2 args)Returns the values of a record's fields formatted for display, keyed by field id.
autoPrefillProjectEntity! (3 args)Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create.
ProjectSharingClientRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProjectSharingClientRelation records.

FieldTypeDescription
getByIdProjectSharingClientRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProjectSharingClientRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProjectSharingClientRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProjectSharingClientRelationEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProjectSharingSalesUnitRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for ProjectSharingSalesUnitRelation records.

FieldTypeDescription
getByIdProjectSharingSalesUnitRelationEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProjectSharingSalesUnitRelationEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProjectSharingSalesUnitRelationEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProjectSharingSalesUnitRelationEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getChangedFieldsSinceRevision[UUID!]! (2 args)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
ProjectTypeOrderByNestedInput input 9 fields: id, isDeleted, modified, …

Sorting by a field of the related ProjectType record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
iconOrderByEnumIcon used to display projects of this type in the UI (e.g. GeneralIcon, Account).
isReadonlyOrderByEnumTrue when the project type is system-managed and cannot be edited or deleted by users.
nameOrderByEnumName of the entity and its default text representation.
isPublishedOrderByEnumTrue when the entity configuration is published; false while it exists only as an unpublished draft.
revisionOrderByEnumRevision when entity was lastly changed.
ProjectTypeRepository object 7 fields: getById, getByIds, getAll, …

Read operations for ProjectType records.

FieldTypeDescription
getByIdProjectTypeEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ProjectTypeEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ProjectTypeEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaProjectTypeEntityConnection (7 args)Returns the records that match the filter as a cursor-paginated connection.
getPublished[ProjectTypeEntity!]! (5 args)Returns the published records that match the filter, paged with limit and offset.
getDrafts[ProjectTypeEntity!]! (2 args)Returns the records that match the filter, with pending unpublished changes applied where a draft exists.
getDraftByIdProjectTypeEntity! (1 args)Returns the record with the given id, with its pending unpublished changes applied when a draft exists.