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 indexG

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

GenderEnum GenderEnumFilterInput GenderProperty GenericDrilldownDataGridViewItems GetBulkDownloadStatusInput GetBulkDownloadStatusPayload GetBulkDownloadUrlInput GetBulkDownloadUrlPayload GhostContactAccountAccountRoleRelationEntity GhostContactAccountAccountRoleRelationEntityConnection GhostContactAccountAccountRoleRelationEntityEdge GhostContactAccountAccountRoleRelationFilterInput GhostContactAccountAccountRoleRelationOrderByInput GhostContactAccountAccountRoleRelationRepository GhostContactAccountRelationEntity GhostContactAccountRelationEntityConnection GhostContactAccountRelationEntityEdge GhostContactAccountRelationFilterInput GhostContactAccountRelationOrderByInput GhostContactAccountRelationOrderByNestedInput GhostContactAccountRelationRepository GhostContactEntity GhostContactEntityConnection GhostContactEntityEdge GhostContactFilterInput GhostContactOrderByInput GhostContactOrderByNestedInput GhostContactRepository GhostLeadOpptyContactRelationEntity GhostLeadOpptyContactRelationEntityConnection GhostLeadOpptyContactRelationEntityEdge GhostLeadOpptyContactRelationFilterInput GhostLeadOpptyContactRelationOrderByInput GhostLeadOpptyContactRelationOrderByNestedInput GhostLeadOpptyContactRelationRepository GhostLeadOpptyContactSalesRoleRelationEntity GhostLeadOpptyContactSalesRoleRelationEntityConnection GhostLeadOpptyContactSalesRoleRelationEntityEdge GhostLeadOpptyContactSalesRoleRelationFilterInput GhostLeadOpptyContactSalesRoleRelationOrderByInput GhostLeadOpptyContactSalesRoleRelationRepository GridColumnsOutput GridHighlightChangesParams GroupChildIdParams GroupField GroupInterval GroupOption

Shared types: G

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

GetBulkDownloadStatusInput input requestId: UUID!, clientMutationId: String

Parameters of the getBulkDownloadStatus mutation.

Input fieldTypeDescription
requestIdUUID!Id returned by getBulkDownloadUrl.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
GetBulkDownloadStatusPayload object result: BulkDownloadStatus!, clientMutationId: String

Result of the getBulkDownloadStatus mutation.

FieldTypeDescription
resultBulkDownloadStatus!Progress in percent, the download URL when finished, and an error flag when packing failed or stalled.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
GetBulkDownloadUrlInput input bulkFilter: BulkOperationInput!, entityId: UUID, entityType: EntityNameEnum, clientMutationId: String

Parameters of the getBulkDownloadUrl mutation.

Input fieldTypeDescription
bulkFilterBulkOperationInput!Files and folders to download.
entityIdUUIDId of the record whose document folders are downloaded. Set together with entityType; not allowed for company folders.
entityTypeEntityNameEnumType of the record whose document folders are downloaded. Set together with entityId.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
GetBulkDownloadUrlPayload object result: String, clientMutationId: String

Result of the getBulkDownloadUrl mutation.

FieldTypeDescription
resultStringId of the download request, or empty when the selection contains no downloadable files.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
GhostContactAccountAccountRoleRelationRepository object 5 fields: getById, getByIds, getAll, …

Read operations for GhostContactAccountAccountRoleRelation records.

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

Read operations for GhostContactAccountRelation records.

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

Sorting by a field of the related GhostContact 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.
positionOrderByEnumJob title or position of the placeholder contact (org-chart label).
revisionOrderByEnumRevision when entity was lastly changed.
GhostContactRepository object 5 fields: getById, getByIds, getAll, …

Read operations for GhostContact records.

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

Read operations for GhostLeadOpptyContactRelation records.

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

Read operations for GhostLeadOpptyContactSalesRoleRelation records.

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