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 indexH

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

HardcodedAggregationType HardCodedContainer HardcodedContainerTypeEnum HardcodedRelation HardCodedRelation HardCodedRelationParams HealthCategory HighlightPeriodEnum

Shared types: H

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

HardCodedContainer object 5 fields: id, onMobile, kind, …

Fixed block of a record form with predefined content, such as the account, contact or product name.

FieldTypeDescription
idUUID!Unique id of the form layout item.
onMobileBooleanWhen true, this item is shown in the mobile app.
kindFormItemKindEnum!Kind of layout item — separator, subsection, container, hardcoded container or step container.
typeHardcodedContainerTypeEnum!Which built-in region this renders — account, contact or product name, or the message-to-sales-team block on a lost form.
inAddinBooleanWhen true, this region is shown in the email add-in.
HardcodedContainerTypeEnum enum AccountName, ContactName, ProductName, MessageToSalesTeam

Built-in region placed on a form layout.

ValueDescription
AccountNameAccount name block.
ContactNameContact name block.
ProductNameProduct name block.
MessageToSalesTeamMessage-to-sales-team block on a lost form.
HardCodedRelationParams input kind: SiblingRelationType!

Predefined relation that links a filter box to the filtered records.

Input fieldTypeDescription
kindSiblingRelationType!Predefined relationship that links this filter box to the main record type (for example Primary, Aggregation, NextScheduledActivity).