Developers
ChangelogSupportcoevera.comGet API keys
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 indexB

Types: B

View as Markdown/reference/graphql/types/b.mdOpen in ClaudeAsk Claude about this pageOpen in ChatGPTAsk ChatGPT about this page

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

BackToLeadInput BackToLeadPayload Base64 BaseEntityTypeEnum BaseEntityTypeEnumFilterInput BetterDashboardAgenda BetterDashboardSchema BetterForecastSchema Boolean BulkActivateUserTargetInput BulkActivateUserTargetPayload BulkArchiveAccountInput BulkArchiveAccountPayload BulkArchiveContactInput BulkArchiveContactPayload BulkArchiveLeadInput BulkArchiveLeadPayload BulkArchiveOpportunityInput BulkArchiveOpportunityPayload BulkArchiveQuoteInput BulkArchiveQuotePayload BulkBackToLeadInput BulkBackToLeadPayload BulkDownloadStatus BulkErrorResult BulkFinishUserTargetInput BulkFinishUserTargetPayload BulkMoveLeadInput BulkMoveLeadPayload BulkMoveOpportunityInput BulkMoveOpportunityPayload BulkMoveQuoteInput BulkMoveQuotePayload BulkOperationInput BulkQualifyLeadInput BulkQualifyLeadPayload BulkReactivateAccountInput BulkReactivateAccountPayload BulkReactivateContactInput BulkReactivateContactPayload BulkReactivateLeadInput BulkReactivateLeadPayload BulkReactivateOpportunityInput BulkReactivateOpportunityPayload BulkReactivateQuoteInput BulkReactivateQuotePayload BulkRemoveTargetInput BulkRemoveTargetPayload BulkUpdateAccountKPIPayload BulkUpdateAccountPayload BulkUpdateAccountProductPricingPayload BulkUpdateAccountRelationLabelPayload BulkUpdateAccountRelationPayload BulkUpdateAccountRelationTypePayload BulkUpdateAccountRolePayload BulkUpdateAccountSharingClientRelationPayload BulkUpdateAccountSharingSalesUnitRelationPayload BulkUpdateAccountSocialRelationPayload BulkUpdateActivityCommentPayload BulkUpdateActivityKPIPayload BulkUpdateActivityRelationPayload BulkUpdateAllowedAccountTypePayload BulkUpdateAllowedAppointmentTypePayload BulkUpdateAllowedCompanyEmailPayload BulkUpdateAllowedCompanyPhonePayload BulkUpdateAllowedContactTypePayload BulkUpdateAllowedLeadTypePayload BulkUpdateAllowedPipelinePayload BulkUpdateAllowedQuoteTypePayload BulkUpdateAllowedTaskTypePayload BulkUpdateAppointmentClientInviteesRelationPayload BulkUpdateAppointmentContactInviteesRelationPayload BulkUpdateAppointmentPayload BulkUpdateAppointmentReminderPayload BulkUpdateAppointmentSchedulePayload BulkUpdateApprovalApproverPayload BulkUpdateApprovalPayload BulkUpdateApprovalProcessActivityLogLinePayload BulkUpdateApprovalProcessPayload BulkUpdateCallPayload BulkUpdateChatConversationPayload BulkUpdateClientExcludedOpptyPayload BulkUpdateClientFavoritePayload BulkUpdateClientPayload BulkUpdateClientStoryReadPayload BulkUpdateCloudObjectFolderPayload BulkUpdateCloudObjectPayload BulkUpdateCloudObjectRelationPayload BulkUpdateCloudObjectStepRelationPayload BulkUpdateCloudObjectTemplatePayload BulkUpdateContactAccountAccountRoleRelationPayload BulkUpdateContactAccountRelationPayload BulkUpdateContactKPIPayload BulkUpdateContactPayload BulkUpdateContactRelationLabelPayload BulkUpdateContactRelationPayload BulkUpdateContactRelationTypePayload BulkUpdateContactSharingClientRelationPayload BulkUpdateContactSharingSalesUnitRelationPayload BulkUpdateContactSocialRelationPayload BulkUpdateCountryCrmPayload BulkUpdateCurrencyExchangeRatePayload BulkUpdateCurrencyExchangeRatesListPayload BulkUpdateCurrencyPayload BulkUpdateCustomEntityDataExRelationPayload BulkUpdateCustomEntitySharingClientRelationPayload BulkUpdateCustomEntitySharingSalesUnitRelationPayload BulkUpdateEmailContentSharingClientRelationPayload BulkUpdateEmailContentSharingSalesUnitRelationPayload BulkUpdateEmailEventPayload BulkUpdateEmailLabelPayload BulkUpdateEmailLabelRelationPayload BulkUpdateEmailPayload BulkUpdateEmailSequenceActivityLogLinePayload BulkUpdateEmailSequenceActivityLogPayload BulkUpdateEmailSequenceEnrolledPayload BulkUpdateEmailSequencePayload BulkUpdateEmailTemplateFolderPayload BulkUpdateEmailTemplatePayload BulkUpdateEmailTemplateSharingClientRelationPayload BulkUpdateEmailTemplateSharingSalesUnitRelationPayload BulkUpdateEmailThreadMailboxClientReadStatePayload BulkUpdateEntitiesPayload BulkUpdateEntityFitnessIndicatorPayload BulkUpdateEntityScoringPayload BulkUpdateFieldMappingPayload BulkUpdateForecastPayload BulkUpdateFormViewPayload BulkUpdateFormViewSharingClientRelationPayload BulkUpdateFormViewSharingSalesUnitRelationPayload BulkUpdateGhostContactAccountAccountRoleRelationPayload BulkUpdateGhostContactAccountRelationPayload BulkUpdateGhostContactPayload BulkUpdateGhostLeadOpptyContactRelationPayload BulkUpdateGhostLeadOpptyContactSalesRoleRelationPayload BulkUpdateImportMappingMaskPayload BulkUpdateLeadOpptyAccountRelationPayload BulkUpdateLeadOpptyContactGroupRelationPayload BulkUpdateLeadOpptyContactRelationPayload BulkUpdateLeadOpptyContactSalesRoleRelationPayload BulkUpdateLeadOpptyKPIPayload BulkUpdateLeadOpptySharingClientRelationPayload BulkUpdateLeadOpptySharingSalesUnitRelationPayload BulkUpdateLeadOpptyStepCheckListRelationPayload BulkUpdateLeadPayload BulkUpdateLeadProcessPayload BulkUpdateMasterRightPayload BulkUpdateMediaPayload BulkUpdateMemoCommentPayload BulkUpdateMemoPayload BulkUpdateMessageRelationPayload BulkUpdateMessageSharingClientRelationPayload BulkUpdateMessageSharingSalesUnitRelationPayload BulkUpdateNotePayload BulkUpdateOnlineFormActivityLogLinePayload BulkUpdateOnlineFormDataExRelationPayload BulkUpdateOnlineFormPayload BulkUpdateOnlineFormRelationPayload BulkUpdateOnlineFormStylePayload BulkUpdateOnlineFormTypeEmailRelationPayload BulkUpdateOnlineFormTypePayload BulkUpdateOpportunityPayload BulkUpdateOpptyProductRelationDataExRelationPayload BulkUpdateOpptyProductRelationPayload BulkUpdateOpptyRecurrencePayload BulkUpdateParentAccountRelationTypePayload BulkUpdatePayload BulkUpdatePhonePayload BulkUpdatePipelinePayload BulkUpdateProcessActivityLogLinePayload BulkUpdateProcessActivityLogPayload BulkUpdateProcessPayload BulkUpdateProcessTemplatePayload BulkUpdateProductCategoryPayload BulkUpdateProductPayload BulkUpdateProductPipelineRelationPayload BulkUpdateProductPriceListPayload BulkUpdateProductPriceListPricePayload BulkUpdateProfileRelationPayload BulkUpdateProjectContactRelationPayload BulkUpdateProjectKPIPayload BulkUpdateProjectObjectivePayload BulkUpdateProjectPayload BulkUpdateProjectSharingClientRelationPayload BulkUpdateProjectSharingSalesUnitRelationPayload BulkUpdateQuoteAccountRelationPayload BulkUpdateQuoteContactRelationPayload BulkUpdateQuoteDataExRelationPayload BulkUpdateQuoteKPIPayload BulkUpdateQuotePayload BulkUpdateQuoteProcessPayload BulkUpdateQuoteSharingClientRelationPayload BulkUpdateQuoteSharingSalesUnitRelationPayload BulkUpdateReportSchedulePayload BulkUpdateResult BulkUpdateResultMap BulkUpdateResults BulkUpdateSalesRolePayload BulkUpdateSalesUnitPayload BulkUpdateSolutionPayload BulkUpdateSolutionTemplatePayload BulkUpdateStepChecklistPayload BulkUpdateStepChecklistSalesRoleRelationPayload BulkUpdateStepPayload BulkUpdateTagPayload BulkUpdateTagRelationPayload BulkUpdateTargetPayload BulkUpdateTargetRelationPayload BulkUpdateTaskPayload BulkUpdateTaskRecurrencePayload BulkUpdateTaskReminderPayload BulkUpdateTaskSharingClientRelationPayload BulkUpdateTaskSharingSalesUnitRelationPayload BulkUpdateTextMessageConversationRelationsPayload BulkUpdateUnsubscribedPhonePayload BulkUpdateWebhookEventPayload BulkUpdateWebhookPayload

Shared types: B

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

Base64 scalar scalar

Binary data encoded as a Base64 string.

BaseEntityTypeEnum enum Lead, Account, Contact, Opportunity, Task, Appointment, … (12 values)

Main record entity (lead, account, contact, opportunity, activity, opportunity product line, project, quote, online form, custom entity or product) that a setting, relation or query applies to.

ValueDescription
LeadPotential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost.
AccountCompany or organization the sales team works with; contacts, leads, opportunities and activities are linked to it.
ContactPerson the sales team works with, usually linked to one or more accounts, leads and opportunities.
OpportunityPotential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost.
TaskTask (e.g. a to-do or a call) owned by a user, with an optional due date, and linked to records.
AppointmentMeeting or call scheduled in the calendar, with its invited users and contacts, linked to the records it concerns.
OpptyProductRelationProduct line of an opportunity.
ProjectProject delivered for an account or run internally, with its objectives, activities and progress.
QuotePrice offer for a customer, usually prepared from an opportunity, with product line items; it moves through a quote process.
OnlineFormSubmission (response) of an online form, with the answers and the records it created or updated.
CustomEntityRecord of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities.
ProductProduct or service in the catalog that can be added as a line item to opportunities and quotes.
BaseEntityTypeEnumFilterInput input eq: [BaseEntityTypeEnum!], NOT: BaseEntityTypeEnumFilterInput

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

Input fieldTypeDescription
eq[BaseEntityTypeEnum!]Matches any of the listed values.
NOTBaseEntityTypeEnumFilterInputMatches values that do not meet this condition.
BetterDashboardAgenda object items: NavigatorAgendaItemConnection, overdueTasks: OverdueTasks!

Agenda of a dashboard item: upcoming tasks, appointments and opportunities, and overdue tasks.

FieldTypeDescription
itemsNavigatorAgendaItemConnection (4 args)Agenda items up to the end of the agenda period, of the kinds the item shows: tasks by due date, appointments, and opportunities by closing date or step deadline.
overdueTasksOverdueTasks!Uncompleted tasks due before today that match the agenda activity filter.
Boolean scalar scalar

The Boolean scalar type represents true or false.

BulkDownloadStatus object progress: Int, url: String, error: Boolean

Progress of packing files into a ZIP archive for download, and its URL once it is ready.

FieldTypeDescription
progressIntProgress of packing the archive, in percent (0 to 100).
urlStringDownload URL of the ZIP archive, set once packing has finished.
errorBooleanTrue when packing failed or stopped making progress.
BulkOperationInput input excludedIds: [UUID], includedIds: [UUID], sessionId: String

Records a bulk operation works on: the records of sessionId plus includedIds, minus excludedIds.

Input fieldTypeDescription
excludedIds[UUID]Ids left out of the selection, even when listed in includedIds or sessionId.
includedIds[UUID]Ids of the records to process.
sessionIdStringId of an open list view whose records are added to the selection. Integrations can leave it empty.
BulkUpdateResultMap object index: Int!, id: ID!

A record created by a bulk operation.

FieldTypeDescription
indexInt!Position of the item in input, starting at 0.
idID!Id of the created record.
BulkUpdateResults object 5 fields: created, errors, updated, …

Outcome of a bulk update: the created, updated and deleted records, and the failed items.

FieldTypeDescription
created[BulkUpdateResultMap]!Records created, each with its position in input.
errors[BulkErrorResult]!Items of input that failed, with their position and error.
updated[UUID]!Ids of the updated records.
deleted[UUID]!Ids of the deleted records.
errorsOnDelete[BulkErrorResult]!Items of deleteInput that failed, with their position and error.