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

GraphQLRepositoriescustomEntityRelationData

entities.customEntityRelationData

Read custom entity relation data records with the customEntityRelationData repository.

Queries

Fields of entities { customEntityRelationData { … } }.

KindFieldReturns
QUERYgetById(entityId: ID!)
Returns the record with the given id, or null when there is none. Deleted records are returned as well.
CustomEntityRelationDataEntity
QUERYgetByIds(entityIds: [ID!]!)
Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
[CustomEntityRelationDataEntity!]!
QUERYgetAll(limit: Int, offset: Int, filter: CustomEntityRelationDataFilterInput, orderBy: [CustomEntityRelationDataOrderByInput!], includeDeleted: Boolean)
Returns the records that match the filter, paged with limit and offset.
[CustomEntityRelationDataEntity!]!
QUERYgetByCriteria(filter: CustomEntityRelationDataFilterInput, orderBy: [CustomEntityRelationDataOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)
Returns the records that match the filter as a cursor-paginated connection.
CustomEntityRelationDataEntityConnection
QUERYgetChangedFieldsSinceRevision(id: UUID!, revision: Int!)
Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
[UUID!]!

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

CustomEntityRelationDataEntity object 54 fields: isDeleteProtected, id, isDeleted, …

Link between two records made through a custom relation, such as an account linked to a custom entity record.

FieldTypeDescription
isDeleteProtectedBoolean!True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
idID!Unique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
account1AccountEntityAccount on the field1 side of this custom relation link; empty when that record is of another type.
account2AccountEntityAccount on the field2 side of this custom relation link; empty when that record is of another type.
appointment1AppointmentEntityAppointment on the field1 side of this custom relation link; empty when that record is of another type.
task1TaskEntityTask on the field1 side of this custom relation link; empty when that record is of another type.
appointment2AppointmentEntityAppointment on the field2 side of this custom relation link; empty when that record is of another type.
task2TaskEntityTask on the field2 side of this custom relation link; empty when that record is of another type.
client1ClientEntityUser on the field1 side of this custom relation link; empty when that record is of another type.
client2ClientEntityUser on the field2 side of this custom relation link; empty when that record is of another type.
contact1ContactEntityContact on the field1 side of this custom relation link; empty when that record is of another type.
contact2ContactEntityContact on the field2 side of this custom relation link; empty when that record is of another type.
customEntity1CustomEntityEntityCustom entity record on the field1 side of this custom relation link; empty when that record is of another type.
customEntity2CustomEntityEntityCustom entity record on the field2 side of this custom relation link; empty when that record is of another type.
customEntityRelationCustomEntityRelationEntityCustom relation (pair of lookup fields) this link belongs to.
lead1LeadEntityLead on the field1 side of this custom relation link; empty when that record is of another type.
oppty1OpportunityEntityOpportunity on the field1 side of this custom relation link; empty when that record is of another type.
lead2LeadEntityLead on the field2 side of this custom relation link; empty when that record is of another type.
oppty2OpportunityEntityOpportunity on the field2 side of this custom relation link; empty when that record is of another type.
opptyProductRelation1OpptyProductRelationEntityOpportunity product line on the field1 side of this custom relation link; empty when that record is of another type.
opptyProductRelation2OpptyProductRelationEntityOpportunity product line on the field2 side of this custom relation link; empty when that record is of another type.
product1ProductEntityProduct on the field1 side of this custom relation link; empty when that record is of another type.
product2ProductEntityProduct on the field2 side of this custom relation link; empty when that record is of another type.
project1ProjectEntityProject on the field1 side of this custom relation link; empty when that record is of another type.
project2ProjectEntityProject on the field2 side of this custom relation link; empty when that record is of another type.
quote1QuoteEntityQuote on the field1 side of this custom relation link; empty when that record is of another type.
quote2QuoteEntityQuote on the field2 side of this custom relation link; empty when that record is of another type.
account1IdIDId of the account on the field1 side of this custom relation link; empty when that record is of another type.
account2IdIDId of the account on the field2 side of this custom relation link; empty when that record is of another type.
activity1IdIDId of the appointment or task on the field1 side of this custom relation link; empty when that record is of another type.
activity2IdIDId of the appointment or task on the field2 side of this custom relation link; empty when that record is of another type.
client1IdIDId of the user on the field1 side of this custom relation link; empty when that record is of another type.
client2IdIDId of the user on the field2 side of this custom relation link; empty when that record is of another type.
contact1IdIDId of the contact on the field1 side of this custom relation link; empty when that record is of another type.
contact2IdIDId of the contact on the field2 side of this custom relation link; empty when that record is of another type.
customEntity1IdIDId of the custom entity record on the field1 side of this custom relation link; empty when that record is of another type.
customEntity2IdIDId of the custom entity record on the field2 side of this custom relation link; empty when that record is of another type.
customEntityRelationIdID!Id of the custom relation this link belongs to.
isPrimaryBooleanTrue when the linked record is the primary one among the records linked through the same lookup field; used when the custom relation has hasIsPrimary enabled.
leadOppty1IdIDId of the lead or opportunity on the field1 side of this custom relation link; empty when that record is of another type.
leadOppty2IdIDId of the lead or opportunity on the field2 side of this custom relation link; empty when that record is of another type.
opptyProductRelation1IdIDId of the opportunity product line on the field1 side of this custom relation link; empty when that record is of another type.
opptyProductRelation2IdIDId of the opportunity product line on the field2 side of this custom relation link; empty when that record is of another type.
product1IdIDId of the product on the field1 side of this custom relation link; empty when that record is of another type.
product2IdIDId of the product on the field2 side of this custom relation link; empty when that record is of another type.
project1IdIDId of the project on the field1 side of this custom relation link; empty when that record is of another type.
project2IdIDId of the project on the field2 side of this custom relation link; empty when that record is of another type.
quote1IdIDId of the quote on the field1 side of this custom relation link; empty when that record is of another type.
quote2IdIDId of the quote on the field2 side of this custom relation link; empty when that record is of another type.
revisionIntRevision when entity was lastly changed.
instancePermissions[EntityPermsEnum!]! (1 args)Permissions the current user has on this record, out of the requested ones.
CustomEntityRelationDataEntityConnection object pageInfo: PageInfo!, edges: [CustomEntityRelationDataEntityEdge]!, totalCount: Int

Paginated list of CustomEntityRelationData records.

FieldTypeDescription
pageInfoPageInfo!Pagination data for this connection.
edges[CustomEntityRelationDataEntityEdge]!Contains the nodes in this connection.
totalCountIntTotal number of items in the connection.
CustomEntityRelationDataEntityEdge object node: CustomEntityRelationDataEntity, cursor: String!

A Relay edge containing a CustomEntityRelationDataEntity and its cursor.

FieldTypeDescription
nodeCustomEntityRelationDataEntityThe item at the end of the edge
cursorString!A cursor for use in pagination
CustomEntityRelationDataFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for CustomEntityRelationData records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input fieldTypeDescription
OR[CustomEntityRelationDataFilterInput!]Matches records that meet at least one of the listed filters.
AND[CustomEntityRelationDataFilterInput!]Matches records that meet all of the listed filters.
NOTCustomEntityRelationDataFilterInputMatches records that do not meet this filter.
globalSearchQueryStringSearch term matched against the fields that the global search covers for this entity.
idEntityFilterStringFieldUnique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedEntityFilterDateTimeFieldLast modification time.
createdEntityFilterDateTimeFieldCreation time.
account1IdEntityFilterStringFieldId of the account on the field1 side of this custom relation link; empty when that record is of another type.
account2IdEntityFilterStringFieldId of the account on the field2 side of this custom relation link; empty when that record is of another type.
activity1IdEntityFilterStringFieldId of the appointment or task on the field1 side of this custom relation link; empty when that record is of another type.
activity2IdEntityFilterStringFieldId of the appointment or task on the field2 side of this custom relation link; empty when that record is of another type.
client1IdEntityFilterStringFieldId of the user on the field1 side of this custom relation link; empty when that record is of another type.
client2IdEntityFilterStringFieldId of the user on the field2 side of this custom relation link; empty when that record is of another type.
contact1IdEntityFilterStringFieldId of the contact on the field1 side of this custom relation link; empty when that record is of another type.
contact2IdEntityFilterStringFieldId of the contact on the field2 side of this custom relation link; empty when that record is of another type.
customEntity1IdEntityFilterStringFieldId of the custom entity record on the field1 side of this custom relation link; empty when that record is of another type.
customEntity2IdEntityFilterStringFieldId of the custom entity record on the field2 side of this custom relation link; empty when that record is of another type.
customEntityRelationIdEntityFilterStringFieldId of the custom relation this link belongs to.
isPrimaryBooleanTrue when the linked record is the primary one among the records linked through the same lookup field; used when the custom relation has hasIsPrimary enabled.
leadOppty1IdEntityFilterStringFieldId of the lead or opportunity on the field1 side of this custom relation link; empty when that record is of another type.
leadOppty2IdEntityFilterStringFieldId of the lead or opportunity on the field2 side of this custom relation link; empty when that record is of another type.
opptyProductRelation1IdEntityFilterStringFieldId of the opportunity product line on the field1 side of this custom relation link; empty when that record is of another type.
opptyProductRelation2IdEntityFilterStringFieldId of the opportunity product line on the field2 side of this custom relation link; empty when that record is of another type.
product1IdEntityFilterStringFieldId of the product on the field1 side of this custom relation link; empty when that record is of another type.
product2IdEntityFilterStringFieldId of the product on the field2 side of this custom relation link; empty when that record is of another type.
project1IdEntityFilterStringFieldId of the project on the field1 side of this custom relation link; empty when that record is of another type.
project2IdEntityFilterStringFieldId of the project on the field2 side of this custom relation link; empty when that record is of another type.
quote1IdEntityFilterStringFieldId of the quote on the field1 side of this custom relation link; empty when that record is of another type.
quote2IdEntityFilterStringFieldId of the quote on the field2 side of this custom relation link; empty when that record is of another type.
revisionEntityFilterNumberFieldRevision when entity was lastly changed.
account1AccountFilterInputAccount on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
account2AccountFilterInputAccount on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
appointment1AppointmentFilterInputAppointment on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
task1TaskFilterInputTask on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
appointment2AppointmentFilterInputAppointment on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
task2TaskFilterInputTask on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
client1ClientFilterInputUser on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
client2ClientFilterInputUser on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
contact1ContactFilterInputContact on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
contact2ContactFilterInputContact on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
customEntity1CustomEntityFilterInputCustom entity record on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
customEntity2CustomEntityFilterInputCustom entity record on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
customEntityRelationCustomEntityRelationFilterInputCustom relation (pair of lookup fields) this link belongs to. Matches records where a related record meets these conditions.
lead1LeadFilterInputLead on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
oppty1OpportunityFilterInputOpportunity on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
lead2LeadFilterInputLead on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
oppty2OpportunityFilterInputOpportunity on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
opptyProductRelation1OpptyProductRelationFilterInputOpportunity product line on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
opptyProductRelation2OpptyProductRelationFilterInputOpportunity product line on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
product1ProductFilterInputProduct on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
product2ProductFilterInputProduct on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
project1ProjectFilterInputProject on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
project2ProjectFilterInputProject on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
quote1QuoteFilterInputQuote on the field1 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
quote2QuoteFilterInputQuote on the field2 side of this custom relation link; empty when that record is of another type. Matches records where a related record meets these conditions.
CustomEntityRelationDataOrderByInput input Asc or Desc per field

Sorting of CustomEntityRelationData records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
account1[AccountOrderByNestedInput!]Account on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
account2[AccountOrderByNestedInput!]Account on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
appointment1[AppointmentOrderByNestedInput!]Appointment on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
task1[TaskOrderByNestedInput!]Task on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
appointment2[AppointmentOrderByNestedInput!]Appointment on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
task2[TaskOrderByNestedInput!]Task on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
client1[ClientOrderByNestedInput!]User on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
client2[ClientOrderByNestedInput!]User on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
contact1[ContactOrderByNestedInput!]Contact on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
contact2[ContactOrderByNestedInput!]Contact on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
customEntity1[CustomEntityOrderByNestedInput!]Custom entity record on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
customEntity2[CustomEntityOrderByNestedInput!]Custom entity record on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
customEntityRelation[CustomEntityRelationOrderByNestedInput!]Custom relation (pair of lookup fields) this link belongs to. Sorts by fields of the related record, listed in order of priority.
lead1[LeadOrderByNestedInput!]Lead on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
oppty1[OpportunityOrderByNestedInput!]Opportunity on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
lead2[LeadOrderByNestedInput!]Lead on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
oppty2[OpportunityOrderByNestedInput!]Opportunity on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
opptyProductRelation1[OpptyProductRelationOrderByNestedInput!]Opportunity product line on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
opptyProductRelation2[OpptyProductRelationOrderByNestedInput!]Opportunity product line on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
product1[ProductOrderByNestedInput!]Product on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
product2[ProductOrderByNestedInput!]Product on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
project1[ProjectOrderByNestedInput!]Project on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
project2[ProjectOrderByNestedInput!]Project on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
quote1[QuoteOrderByNestedInput!]Quote on the field1 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
quote2[QuoteOrderByNestedInput!]Quote on the field2 side of this custom relation link; empty when that record is of another type. Sorts by fields of the related record, listed in order of priority.
account1IdOrderByEnumId of the account on the field1 side of this custom relation link; empty when that record is of another type.
account2IdOrderByEnumId of the account on the field2 side of this custom relation link; empty when that record is of another type.
activity1IdOrderByEnumId of the appointment or task on the field1 side of this custom relation link; empty when that record is of another type.
activity2IdOrderByEnumId of the appointment or task on the field2 side of this custom relation link; empty when that record is of another type.
client1IdOrderByEnumId of the user on the field1 side of this custom relation link; empty when that record is of another type.
client2IdOrderByEnumId of the user on the field2 side of this custom relation link; empty when that record is of another type.
contact1IdOrderByEnumId of the contact on the field1 side of this custom relation link; empty when that record is of another type.
contact2IdOrderByEnumId of the contact on the field2 side of this custom relation link; empty when that record is of another type.
customEntity1IdOrderByEnumId of the custom entity record on the field1 side of this custom relation link; empty when that record is of another type.
customEntity2IdOrderByEnumId of the custom entity record on the field2 side of this custom relation link; empty when that record is of another type.
customEntityRelationIdOrderByEnumId of the custom relation this link belongs to.
isPrimaryOrderByEnumTrue when the linked record is the primary one among the records linked through the same lookup field; used when the custom relation has hasIsPrimary enabled.
leadOppty1IdOrderByEnumId of the lead or opportunity on the field1 side of this custom relation link; empty when that record is of another type.
leadOppty2IdOrderByEnumId of the lead or opportunity on the field2 side of this custom relation link; empty when that record is of another type.
opptyProductRelation1IdOrderByEnumId of the opportunity product line on the field1 side of this custom relation link; empty when that record is of another type.
opptyProductRelation2IdOrderByEnumId of the opportunity product line on the field2 side of this custom relation link; empty when that record is of another type.
product1IdOrderByEnumId of the product on the field1 side of this custom relation link; empty when that record is of another type.
product2IdOrderByEnumId of the product on the field2 side of this custom relation link; empty when that record is of another type.
project1IdOrderByEnumId of the project on the field1 side of this custom relation link; empty when that record is of another type.
project2IdOrderByEnumId of the project on the field2 side of this custom relation link; empty when that record is of another type.
quote1IdOrderByEnumId of the quote on the field1 side of this custom relation link; empty when that record is of another type.
quote2IdOrderByEnumId of the quote on the field2 side of this custom relation link; empty when that record is of another type.
revisionOrderByEnumRevision when entity was lastly changed.
CustomEntityRelationOrderByNestedInput input 15 fields: id, isDeleted, modified, …

Sorting by a field of the related CustomEntityRelation 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.
field1IdOrderByEnumId of the lookup field on the first side of the custom relation.
field2IdOrderByEnumId of the lookup field on the second side of the custom relation.
hasIsPrimaryOrderByEnumWhen true, one of the records linked through the relation can be marked as primary. Cannot be switched back to false once enabled.
showRelated1OrderByEnumWhen true, field2 offers only records related to the record being edited. Not supported yet; must be false.
showRelated2OrderByEnumWhen true, field1 offers only records related to the record being edited (e.g. the contacts of its account).
showTab1OrderByEnumWhen true, the records linked through field1 are shown in a tab named tabName1.
showTab2OrderByEnumWhen true, the records linked through field2 are shown in a tab named tabName2.
tabName1OrderByEnumName of the tab that shows the records linked through field1.
tabName2OrderByEnumName of the tab that shows the records linked through field2.
isPublishedOrderByEnumTrue when the entity configuration is published; false while it exists only as an unpublished draft.
revisionOrderByEnumRevision when entity was lastly changed.