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 indexW

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

WarningLevelEnum WebhookEntity WebhookEntityConnection WebhookEntityEdge WebhookEventEntity WebhookEventEntityConnection WebhookEventEntityEdge WebhookEventFilterInput WebhookEventOrderByInput WebhookEventRepository WebhookFilterInput WebhookOrderByInput WebhookOrderByNestedInput WebhookRepository WebResource WebresourceEntity WebresourceEntityConnection WebresourceEntityEdge WebresourceFilterInput WebresourceOrderByInput WebresourceRepository

Shared types: W

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

WarningLevelEnum enum Ok, Notice, Warning, Error

Severity of a fitness indicator on a lead or opportunity.

ValueDescription
OkNo issue.
NoticeMinor issue worth noticing.
WarningIssue that needs attention.
ErrorSerious issue.
WebhookEventRepository object 5 fields: getById, getByIds, getAll, …

Read operations for WebhookEvent records.

FieldTypeDescription
getByIdWebhookEventEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[WebhookEventEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[WebhookEventEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaWebhookEventEntityConnection (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.
WebhookRepository object 5 fields: getById, getByIds, getAll, …

Read operations for Webhook records.

FieldTypeDescription
getByIdWebhookEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[WebhookEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[WebhookEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaWebhookEntityConnection (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.
WebResource object 5 fields: kind, id, size, …

Embedded web content placed in a column of a record form.

FieldTypeDescription
kindFormContainerItemKind!Kind of column item — a placed field or an embedded web resource.
idString!Unique id of the embedded web resource.
sizeInt!Relative width of the web resource within its column.
labelString!Display label of the embedded web resource.
descriptionStringOptional descriptive text for the embedded web resource.
WebresourceRepository object 7 fields: getById, getByIds, getAll, …

Read operations for Webresource records.

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