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

GraphQLRepositoriesallowedContactType

entities.allowedContactType

Read allowed contact type records with the allowedContactType repository, and change them with the allowed contact type mutations. Same records as the REST AllowedContactTypes entity.

Queries

Fields of entities { allowedContactType { … } }.

KindFieldReturns
QUERYgetById(entityId: ID!)
Returns the record with the given id, or null when there is none. Deleted records are returned as well.
AllowedContactTypeEntity
QUERYgetByIds(entityIds: [ID!]!)
Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
[AllowedContactTypeEntity!]!
QUERYgetAll(limit: Int, offset: Int, filter: AllowedContactTypeFilterInput, orderBy: [AllowedContactTypeOrderByInput!], includeDeleted: Boolean)
Returns the records that match the filter, paged with limit and offset.
[AllowedContactTypeEntity!]!
QUERYgetByCriteria(filter: AllowedContactTypeFilterInput, orderBy: [AllowedContactTypeOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)
Returns the records that match the filter as a cursor-paginated connection.
AllowedContactTypeEntityConnection
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!]!

Mutations

KindMutationDoesReturns
MUTATIONcreateAllowedContactType(input: CreateAllowedContactTypeInput!, validationLevel: [ValidationLevel!])Create one recordCreateAllowedContactTypePayload
MUTATIONupdateAllowedContactType(input: UpdateAllowedContactTypeInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)Update fieldsUpdateAllowedContactTypePayload
MUTATIONbulkUpdateAllowedContactType(input: [CreateOrUpdateAllowedContactTypeInput!]!, deleteInput: [DeleteAllowedContactTypeInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)Create or update many; per-item resultsBulkUpdateAllowedContactTypePayload
MUTATIONdeleteAllowedContactType(input: DeleteAllowedContactTypeInput!)Soft-deleteDeleteAllowedContactTypePayload

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.

AllowedContactTypeEntity object 11 fields: isDeleteProtected, id, isDeleted, …

Contact type that a user role is allowed to use.

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.
contactTypeContactTypeEntityContact type the user role can use.
masterRightMasterRightEntityUser role granted access to the contact type.
contactTypeIdID!Id of the contact type the user role can use.
masterRightIdID!Id of the user role.
revisionIntRevision when entity was lastly changed.
instancePermissions[EntityPermsEnum!]! (1 args)Permissions the current user has on this record, out of the requested ones.
AllowedContactTypeEntityConnection object pageInfo: PageInfo!, edges: [AllowedContactTypeEntityEdge]!, totalCount: Int

Paginated list of AllowedContactType records.

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

A Relay edge containing a AllowedContactTypeEntity and its cursor.

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

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

Input fieldTypeDescription
OR[AllowedContactTypeFilterInput!]Matches records that meet at least one of the listed filters.
AND[AllowedContactTypeFilterInput!]Matches records that meet all of the listed filters.
NOTAllowedContactTypeFilterInputMatches 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.
contactTypeIdEntityFilterStringFieldId of the contact type the user role can use.
masterRightIdEntityFilterStringFieldId of the user role.
revisionEntityFilterNumberFieldRevision when entity was lastly changed.
contactTypeContactTypeFilterInputContact type the user role can use. Matches records where a related record meets these conditions.
masterRightMasterRightFilterInputUser role granted access to the contact type. Matches records where a related record meets these conditions.
AllowedContactTypeOrderByInput input Asc or Desc per field

Sorting of AllowedContactType 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.
contactType[ContactTypeOrderByNestedInput!]Contact type the user role can use. Sorts by fields of the related record, listed in order of priority.
masterRight[MasterRightOrderByNestedInput!]User role granted access to the contact type. Sorts by fields of the related record, listed in order of priority.
contactTypeIdOrderByEnumId of the contact type the user role can use.
masterRightIdOrderByEnumId of the user role.
revisionOrderByEnumRevision when entity was lastly changed.
CreateAllowedContactTypeInput input 6 fields: clientMutationId, modified, created, …

Field values of a new AllowedContactType record.

Input fieldTypeDescription
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).
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
contactTypeIdID!Id of the contact type the user role can use.
masterRightIdID!Id of the user role.
revisionIntRevision when entity was lastly changed.
CreateOrUpdateAllowedContactTypeInput input 7 fields: clientMutationId, id, modified, …

Field values of an AllowedContactType record to create, or to update when its id is set.

Input fieldTypeDescription
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).
idIDUnique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
contactTypeIdIDId of the contact type the user role can use.
masterRightIdIDId of the user role.
revisionIntRevision when entity was lastly changed.
DeleteAllowedContactTypeInput input clientMutationId: String, id: ID!

Id of the AllowedContactType record to delete.

Input fieldTypeDescription
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).
idID!Unique identifier of entity.
UpdateAllowedContactTypeInput input 7 fields: clientMutationId, id, modified, …

Id of an AllowedContactType record and the field values to change.

Input fieldTypeDescription
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).
idID!Unique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
contactTypeIdIDId of the contact type the user role can use.
masterRightIdIDId of the user role.
revisionIntRevision when entity was lastly changed.
BulkUpdateAllowedContactTypePayload object result: BulkUpdateResults!

Result of the bulkUpdateAllowedContactType mutation.

FieldTypeDescription
resultBulkUpdateResults!Ids of the created, updated and deleted records, and the items that failed.
CreateAllowedContactTypePayload object allowedContactType: AllowedContactTypeEntity, clientMutationId: String

Result of the createAllowedContactType mutation.

FieldTypeDescription
allowedContactTypeAllowedContactTypeEntityThe created record.
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).
DeleteAllowedContactTypePayload object allowedContactType: AllowedContactTypeEntity, clientMutationId: String

Result of the deleteAllowedContactType mutation.

FieldTypeDescription
allowedContactTypeAllowedContactTypeEntityThe deleted record.
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).
UpdateAllowedContactTypePayload object allowedContactType: AllowedContactTypeEntity, clientMutationId: String

Result of the updateAllowedContactType mutation.

FieldTypeDescription
allowedContactTypeAllowedContactTypeEntityThe updated record.
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).