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 indexI

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

ID ImportFieldMappingType ImportMappingMaskEntity ImportMappingMaskEntityConnection ImportMappingMaskEntityEdge ImportMappingMaskFilterInput ImportMappingMaskItem ImportMappingMaskOrderByInput ImportMappingMaskRepository ImportMappingRelationType ImportMaskEntityTypeEnum ImportMaskEntityTypeEnumFilterInput Int IntegerProperty IntEnumItem InterfaceBottomMenuItemKind InterfaceBottomMenuRow InterfaceBottomMenuRowParams InterfaceDetailTab InterfaceDetailTabKind InterfaceDetailWidget InterfaceDetailWidgetKind InterfaceFieldData InterfacePreviewChart InterfacePreviewCustomSettings InterfacePreviewEntity InterfacePreviewFilterInput InterfacePreviewOrderByInput InterfacePreviewRepository InterfacePreviewSettings InviteeResponseEnum InviteeResponseEnumFilterInput

Shared types: I

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

ID scalar scalar

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable.

ImportMappingMaskRepository object 6 fields: getById, getByIds, getAll, …

Read operations for ImportMappingMask records.

FieldTypeDescription
getByIdImportMappingMaskEntity (1 args)Returns the record with the given id, or null when there is none. Deleted records are returned as well.
getByIds[ImportMappingMaskEntity!]! (1 args)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
getAll[ImportMappingMaskEntity!]! (5 args)Returns the records that match the filter, paged with limit and offset.
getByCriteriaImportMappingMaskEntityConnection (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.
getForEntityType[ImportMappingMaskEntity!]! (2 args)Returns the saved import column mappings for the given record type, sorted by name.
Int scalar scalar

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

IntEnumItem object key: String!, value: Int!

Allowed option of a field validator, as a name and an integer value.

FieldTypeDescription
keyString!Display name of the option.
valueInt!Integer value stored for the option.
InterfaceFieldData interface fieldId: UUID!

Value of one field of a record as shown in its preview pane; each implementing type holds the value in its own type.

FieldTypeDescription
fieldIdUUID!Id of the field the value belongs to.
InterfacePreviewRepository object 7 fields: getById, getByIds, getAll, …

Read operations for InterfacePreview records.

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

Response of an invitee to an appointment invitation.

ValueDescription
NoResponseThe invitee has not responded yet.
AcceptedThe invitee accepted the invitation.
RejectedThe invitee declined the invitation.
InviteeResponseEnumFilterInput input eq: [InviteeResponseEnum!], NOT: InviteeResponseEnumFilterInput

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

Input fieldTypeDescription
eq[InviteeResponseEnum!]Matches any of the listed values.
NOTInviteeResponseEnumFilterInputMatches values that do not meet this condition.