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 indexU

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

UnitRoleEnum UnitRoleEnumFilterInput UnsubscribedPhoneEntity UnsubscribedPhoneEntityConnection UnsubscribedPhoneEntityEdge UnsubscribedPhoneFilterInput UnsubscribedPhoneOrderByInput UnsubscribedPhoneRepository UpdateAccountInput UpdateAccountKPIInput UpdateAccountKPIPayload UpdateAccountPayload UpdateAccountProductPricingInput UpdateAccountProductPricingPayload UpdateAccountRelationInput UpdateAccountRelationLabelInput UpdateAccountRelationLabelPayload UpdateAccountRelationPayload UpdateAccountRelationTypeInput UpdateAccountRelationTypePayload UpdateAccountRoleInput UpdateAccountRolePayload UpdateAccountSharingClientRelationInput UpdateAccountSharingClientRelationPayload UpdateAccountSharingSalesUnitRelationInput UpdateAccountSharingSalesUnitRelationPayload UpdateAccountSocialRelationInput UpdateAccountSocialRelationNoIdBackrefInput UpdateAccountSocialRelationPayload UpdateActivityCommentInput UpdateActivityCommentPayload UpdateActivityKPIInput UpdateActivityKPIPayload UpdateActivityRelationInput UpdateActivityRelationPayload UpdateAllowedAccountTypeInput UpdateAllowedAccountTypePayload UpdateAllowedAppointmentTypeInput UpdateAllowedAppointmentTypePayload UpdateAllowedCompanyEmailInput UpdateAllowedCompanyEmailPayload UpdateAllowedCompanyPhoneInput UpdateAllowedCompanyPhonePayload UpdateAllowedContactTypeInput UpdateAllowedContactTypePayload UpdateAllowedLeadTypeInput UpdateAllowedLeadTypePayload UpdateAllowedPipelineInput UpdateAllowedPipelinePayload UpdateAllowedQuoteTypeInput UpdateAllowedQuoteTypePayload UpdateAllowedTaskTypeInput UpdateAllowedTaskTypePayload UpdateAppointmentClientInviteesRelationInput UpdateAppointmentClientInviteesRelationPayload UpdateAppointmentContactInviteesRelationInput UpdateAppointmentContactInviteesRelationPayload UpdateAppointmentInput UpdateAppointmentPayload UpdateAppointmentReminderInput UpdateAppointmentReminderNoAppointmentBackrefInput UpdateAppointmentReminderPayload UpdateAppointmentScheduleInput UpdateAppointmentSchedulePayload UpdateApprovalApproverInput UpdateApprovalApproverPayload UpdateApprovalInput UpdateApprovalPayload UpdateApprovalProcessActivityLogLineInput UpdateApprovalProcessActivityLogLinePayload UpdateApprovalProcessInput UpdateApprovalProcessPayload UpdateCallInput UpdateCallPayload UpdateChatConversationInput UpdateChatConversationPayload UpdateClientExcludedOpptyInput UpdateClientExcludedOpptyPayload UpdateClientFavoriteInput UpdateClientFavoritePayload UpdateClientInput UpdateClientPayload UpdateClientStoryReadInput UpdateClientStoryReadPayload UpdateCloudObjectFolderInput UpdateCloudObjectFolderPayload UpdateCloudObjectInput UpdateCloudObjectPayload UpdateCloudObjectRelationInput UpdateCloudObjectRelationPayload UpdateCloudObjectStepRelationInput UpdateCloudObjectStepRelationPayload UpdateCloudObjectTemplateInput UpdateCloudObjectTemplatePayload UpdateContactAccountAccountRoleRelationInput UpdateContactAccountAccountRoleRelationPayload UpdateContactAccountRelationInput UpdateContactAccountRelationPayload UpdateContactInput UpdateContactKPIInput UpdateContactKPIPayload UpdateContactPayload UpdateContactRelationInput UpdateContactRelationLabelInput UpdateContactRelationLabelPayload UpdateContactRelationPayload UpdateContactRelationTypeInput UpdateContactRelationTypePayload UpdateContactSharingClientRelationInput UpdateContactSharingClientRelationPayload UpdateContactSharingSalesUnitRelationInput UpdateContactSharingSalesUnitRelationPayload UpdateContactSocialRelationInput UpdateContactSocialRelationNoIdBackrefInput UpdateContactSocialRelationPayload UpdateCountryCrmInput UpdateCountryCrmPayload UpdateCurrencyExchangeRateInput UpdateCurrencyExchangeRatePayload UpdateCurrencyExchangeRatesListInput UpdateCurrencyExchangeRatesListPayload UpdateCurrencyInput UpdateCurrencyPayload UpdateCustomEntityDataExRelationInput UpdateCustomEntityDataExRelationPayload UpdateCustomEntitySharingClientRelationInput UpdateCustomEntitySharingClientRelationPayload UpdateCustomEntitySharingSalesUnitRelationInput UpdateCustomEntitySharingSalesUnitRelationPayload UpdateDataInput UpdateDataPayload UpdateDetailSettingsTargetPayload UpdateDraftFieldInput UpdateDraftTranslationInput UpdateEmailContentSharingClientRelationInput UpdateEmailContentSharingClientRelationPayload UpdateEmailContentSharingSalesUnitRelationInput UpdateEmailContentSharingSalesUnitRelationPayload UpdateEmailEventInput UpdateEmailEventPayload UpdateEmailInput UpdateEmailLabelInput UpdateEmailLabelPayload UpdateEmailLabelRelationInput UpdateEmailLabelRelationPayload UpdateEmailPayload UpdateEmailSequenceActivityLogInput UpdateEmailSequenceActivityLogLineInput UpdateEmailSequenceActivityLogLinePayload UpdateEmailSequenceActivityLogPayload UpdateEmailSequenceEnrolledInput UpdateEmailSequenceEnrolledPayload UpdateEmailSequenceInput UpdateEmailSequencePayload UpdateEmailTemplateFolderInput UpdateEmailTemplateFolderPayload UpdateEmailTemplateInput UpdateEmailTemplatePayload UpdateEmailTemplateSharingClientRelationInput UpdateEmailTemplateSharingClientRelationPayload UpdateEmailTemplateSharingSalesUnitRelationInput UpdateEmailTemplateSharingSalesUnitRelationPayload UpdateEmailThreadMailboxClientReadStateInput UpdateEmailThreadMailboxClientReadStatePayload UpdateEntityFitnessIndicatorInput UpdateEntityFitnessIndicatorPayload UpdateEntityFitnessInput UpdateEntityFitnessPayload UpdateEntityHealthInput UpdateEntityHealthPayload UpdateEntityScoringInput UpdateEntityScoringPayload UpdateFieldMappingInput UpdateFieldMappingPayload UpdateFieldPayload UpdateForecastInput UpdateForecastPayload UpdateFormViewInput UpdateFormViewPayload UpdateFormViewSharingClientRelationInput UpdateFormViewSharingClientRelationPayload UpdateFormViewSharingSalesUnitRelationInput UpdateFormViewSharingSalesUnitRelationPayload UpdateGhostContactAccountAccountRoleRelationInput UpdateGhostContactAccountAccountRoleRelationPayload UpdateGhostContactAccountRelationInput UpdateGhostContactAccountRelationPayload UpdateGhostContactInput UpdateGhostContactPayload UpdateGhostLeadOpptyContactRelationInput UpdateGhostLeadOpptyContactRelationPayload UpdateGhostLeadOpptyContactSalesRoleRelationInput UpdateGhostLeadOpptyContactSalesRoleRelationPayload UpdateImportMappingMaskInput UpdateImportMappingMaskPayload UpdateLeadInput UpdateLeadOpptyAccountRelationInput UpdateLeadOpptyAccountRelationPayload UpdateLeadOpptyContactGroupRelationInput UpdateLeadOpptyContactGroupRelationPayload UpdateLeadOpptyContactRelationInput UpdateLeadOpptyContactRelationPayload UpdateLeadOpptyContactSalesRoleRelationInput UpdateLeadOpptyContactSalesRoleRelationPayload UpdateLeadOpptyKPIInput UpdateLeadOpptyKPIPayload UpdateLeadOpptySharingClientRelationInput UpdateLeadOpptySharingClientRelationPayload UpdateLeadOpptySharingSalesUnitRelationInput UpdateLeadOpptySharingSalesUnitRelationPayload UpdateLeadOpptyStepCheckListRelationInput UpdateLeadOpptyStepCheckListRelationPayload UpdateLeadPayload UpdateLeadProcessInput UpdateLeadProcessPayload UpdateLinkedItemsEmailInput UpdateLinkedItemsEmailPayload UpdateMasterRightInput UpdateMasterRightPayload UpdateMediaInput UpdateMediaPayload UpdateMemoCommentInput UpdateMemoCommentPayload UpdateMemoInput UpdateMemoPayload UpdateMessageRelationInput UpdateMessageRelationPayload UpdateMessageSharingClientRelationInput UpdateMessageSharingClientRelationPayload UpdateMessageSharingSalesUnitRelationInput UpdateMessageSharingSalesUnitRelationPayload UpdateMessagingPhonePayload UpdateNoteInput UpdateNotePayload UpdateOnlineFormActivityLogLineInput UpdateOnlineFormActivityLogLinePayload UpdateOnlineFormDataExRelationInput UpdateOnlineFormDataExRelationPayload UpdateOnlineFormInput UpdateOnlineFormPayload UpdateOnlineFormRelationInput UpdateOnlineFormRelationPayload UpdateOnlineFormStyleInput UpdateOnlineFormStylePayload UpdateOnlineFormTypeEmailRelationInput UpdateOnlineFormTypeEmailRelationPayload UpdateOnlineFormTypeInput UpdateOnlineFormTypePayload UpdateOpportunityInput UpdateOpportunityPayload UpdateOpptyProductRelationDataExRelationInput UpdateOpptyProductRelationDataExRelationPayload UpdateOpptyProductRelationInput UpdateOpptyProductRelationPayload UpdateOpptyProductRelationRevenueScheduleNoIdBackrefInput UpdateOpptyRecurrenceInput UpdateOpptyRecurrenceNoOpptyBackrefInput UpdateOpptyRecurrencePayload UpdateOpptyRevenueScheduleNoIdBackrefInput UpdateParentAccountRelationTypeInput UpdateParentAccountRelationTypePayload UpdatePhoneInput UpdatePhonePayload UpdatePipelineInput UpdatePipelinePayload UpdateProcessActivityLogInput UpdateProcessActivityLogLineInput UpdateProcessActivityLogLinePayload UpdateProcessActivityLogPayload UpdateProcessInput UpdateProcessPayload UpdateProcessTemplateInput UpdateProcessTemplatePayload UpdateProductCategoryInput UpdateProductCategoryPayload UpdateProductInput UpdateProductPayload UpdateProductPipelineRelationInput UpdateProductPipelineRelationPayload UpdateProductPriceListActionEnum UpdateProductPriceListInput UpdateProductPriceListPayload UpdateProductPriceListPriceInput UpdateProductPriceListPricePayload UpdateProfileRelationInput UpdateProfileRelationPayload UpdateProjectContactRelationInput UpdateProjectContactRelationPayload UpdateProjectInput UpdateProjectKPIInput UpdateProjectKPIPayload UpdateProjectObjectiveActivitiesSortInput UpdateProjectObjectiveActivitiesSortPayload UpdateProjectObjectiveInput UpdateProjectObjectivePayload UpdateProjectObjectiveSortInput UpdateProjectObjectiveSortPayload UpdateProjectPayload UpdateProjectSharingClientRelationInput UpdateProjectSharingClientRelationPayload UpdateProjectSharingSalesUnitRelationInput UpdateProjectSharingSalesUnitRelationPayload UpdateQuoteAccountRelationInput UpdateQuoteAccountRelationPayload UpdateQuoteContactRelationInput UpdateQuoteContactRelationPayload UpdateQuoteDataExRelationInput UpdateQuoteDataExRelationPayload UpdateQuoteInput UpdateQuoteKPIInput UpdateQuoteKPIPayload UpdateQuotePayload UpdateQuoteProcessInput UpdateQuoteProcessPayload UpdateQuoteSharingClientRelationInput UpdateQuoteSharingClientRelationPayload UpdateQuoteSharingSalesUnitRelationInput UpdateQuoteSharingSalesUnitRelationPayload UpdateReportScheduleInput UpdateReportSchedulePayload UpdateSalesRoleInput UpdateSalesRolePayload UpdateSalesUnitInput UpdateSalesUnitPayload UpdateSolutionInput UpdateSolutionPayload UpdateSolutionTemplateInput UpdateSolutionTemplatePayload UpdateStepChecklistInput UpdateStepChecklistPayload UpdateStepChecklistSalesRoleRelationInput UpdateStepChecklistSalesRoleRelationPayload UpdateStepInput UpdateStepPayload UpdateTagInput UpdateTagPayload UpdateTagRelationInput UpdateTagRelationPayload UpdateTargetInput UpdateTargetPayload UpdateTargetRelationInput UpdateTargetRelationPayload UpdateTargetSettingsInput UpdateTaskInput UpdateTaskPayload UpdateTaskRecurrenceInput UpdateTaskRecurrenceNoTaskBackrefInput UpdateTaskRecurrencePayload UpdateTaskReminderInput UpdateTaskReminderNoTaskBackrefInput UpdateTaskReminderPayload UpdateTaskSharingClientRelationInput UpdateTaskSharingClientRelationPayload UpdateTaskSharingSalesUnitRelationInput UpdateTaskSharingSalesUnitRelationPayload UpdateTextMessageConversationInput UpdateTextMessageConversationPayload UpdateTextMessageConversationRelationsInput UpdateTextMessageConversationRelationsPayload UpdateTextMessageInput UpdateTextMessagePayload UpdateTranslationPayload UpdateUnsubscribedPhoneInput UpdateUnsubscribedPhonePayload UpdateWebhookEventInput UpdateWebhookEventPayload UpdateWebhookInput UpdateWebhookPayload UploadSourceEnum UploadSourceEnumFilterInput UserRecalculationStateEnum UUID

Shared types: U

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

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

Read operations for UnsubscribedPhone records.

FieldTypeDescription
getByIdUnsubscribedPhoneEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[UnsubscribedPhoneEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[UnsubscribedPhoneEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaUnsubscribedPhoneEntityConnection (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.
UpdateProductPriceListActionEnum enum UpdateAll, UpdateAllExceptModified, DontUpdatePrices

Whether changed price-list prices are applied to existing opportunities and quotes.

ValueDescription
UpdateAllProduct lines of all open opportunities and quotes using the price list get the new prices.
UpdateAllExceptModifiedSame as UpdateAll, but lines whose price was changed manually keep their price.
DontUpdatePricesExisting opportunities and quotes keep their prices (default).
UploadSourceEnum enum EmailTemplate, RichTextEditor

Editor in which an uploaded image is embedded.

ValueDescription
EmailTemplateImage embedded in an email template.
RichTextEditorImage embedded in rich-text content, such as a note or description.
UploadSourceEnumFilterInput input eq: [UploadSourceEnum!], NOT: UploadSourceEnumFilterInput

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

Input fieldTypeDescription
eq[UploadSourceEnum!]Matches any of the listed values.
NOTUploadSourceEnumFilterInputMatches values that do not meet this condition.
UUID scalar scalar

Universally unique identifier, written as a 36-character string such as "0b7a2c4e-8f1d-4c3b-9a6e-5d2f1e0c7b8a".