---
title: entities.contactRelationLabel
description: Read contact relation label records with the contactRelationLabel repository, and change them with the contact relation label mutations. Same records as the REST ContactRelationLabels entity.
canonical: https://developers.coevera.com/reference/graphql/contact-relation-label/
section: graphql
verification: schema
generatedFrom: schema f155746 (2026-10-20)
publisher: Coevera
---

# entities.contactRelationLabel

Read contact relation label records with the contactRelationLabel repository, and change them with the contact relation label mutations. Same records as the REST ContactRelationLabels entity.

REST: [ContactRelationLabels](https://developers.coevera.com/reference/rest/contact-relation-labels.md).

## Queries

- `getById(entityId: ID!): ContactRelationLabelEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [ContactRelationLabelEntity!]!` Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
- `getAll(limit: Int, offset: Int, filter: ContactRelationLabelFilterInput, orderBy: [ContactRelationLabelOrderByInput!], includeDeleted: Boolean): [ContactRelationLabelEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: ContactRelationLabelFilterInput, orderBy: [ContactRelationLabelOrderByInput!], includeDeleted: Boolean): [ContactRelationLabelEntity!]!` Returns the records that match the filter as a cursor-paginated connection.
- `getChangedFieldsSinceRevision(id: UUID!, revision: Int!): [UUID!]!` Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.

## Mutations

- `createContactRelationLabel(input: CreateContactRelationLabelInput!, validationLevel: [ValidationLevel!]): CreateContactRelationLabelPayload` Create one record.
- `updateContactRelationLabel(input: UpdateContactRelationLabelInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateContactRelationLabelPayload` Update fields.
- `bulkUpdateContactRelationLabel(input: [CreateOrUpdateContactRelationLabelInput!]!, deleteInput: [DeleteContactRelationLabelInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateContactRelationLabelPayload` Create or update many; per-item results.
- `deleteContactRelationLabel(input: DeleteContactRelationLabelInput!): DeleteContactRelationLabelPayload` Soft-delete.

## Types

### ContactRelationLabelEntity (object)

Relationship type assigned to a link between two contacts, such as Spouse or Colleague.

- `isDeleteProtected: Boolean!` 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.
- `id: ID!` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `contactRelation: ContactRelationEntity` Contact relationship being labelled.
- `contactRelationType: ContactRelationTypeEntity` Type of the relationship (e.g. spouse, colleague).
- `contactRelationId: ID!` Id of the contact relationship.
- `contactRelationTypeId: ID!` Id of the relationship type.
- `revision: Int` Revision when entity was lastly changed.
- `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones.

### ContactRelationLabelFilterInput (input)

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

- `OR: [ContactRelationLabelFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [ContactRelationLabelFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: ContactRelationLabelFilterInput` Matches records that do not meet this filter.
- `globalSearchQuery: String` Search term matched against the fields that the global search covers for this entity.
- `id: EntityFilterStringField` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: EntityFilterDateTimeField` Last modification time.
- `created: EntityFilterDateTimeField` Creation time.
- `contactRelationId: EntityFilterStringField` Id of the contact relationship.
- `contactRelationTypeId: EntityFilterStringField` Id of the relationship type.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `contactRelation: ContactRelationFilterInput` Contact relationship being labelled. Matches records where a related record meets these conditions.
- `contactRelationType: ContactRelationTypeFilterInput` Type of the relationship (e.g. spouse, colleague). Matches records where a related record meets these conditions.

### ContactRelationLabelOrderByInput (input)

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

- `id: OrderByEnum` Unique identifier of entity.
- `isDeleted: OrderByEnum` Specifies if the entity is considered deleted.
- `modified: OrderByEnum` Last modification time.
- `created: OrderByEnum` Creation time.
- `contactRelation: [ContactRelationOrderByNestedInput!]` Contact relationship being labelled. Sorts by fields of the related record, listed in order of priority.
- `contactRelationType: [ContactRelationTypeOrderByNestedInput!]` Type of the relationship (e.g. spouse, colleague). Sorts by fields of the related record, listed in order of priority.
- `contactRelationId: OrderByEnum` Id of the contact relationship.
- `contactRelationTypeId: OrderByEnum` Id of the relationship type.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### ContactRelationOrderByNestedInput (input)

Sorting by a field of the related ContactRelation record. Set exactly one field in each item.

- `id: OrderByEnum` Unique identifier of entity.
- `isDeleted: OrderByEnum` Specifies if the entity is considered deleted.
- `modified: OrderByEnum` Last modification time.
- `created: OrderByEnum` Creation time.
- `contact1Id: OrderByEnum` Id of the first related contact.
- `contact2Id: OrderByEnum` Id of the second related contact.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### ContactRelationTypeOrderByNestedInput (input)

Sorting by a field of the related ContactRelationType record. Set exactly one field in each item.

- `id: OrderByEnum` Unique identifier of entity.
- `isDeleted: OrderByEnum` Specifies if the entity is considered deleted.
- `modified: OrderByEnum` Last modification time.
- `created: OrderByEnum` Creation time.
- `color: OrderByEnum` Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.
- `label: OrderByEnum` Display label of the contact-to-contact relationship type (e.g. Spouse, Colleague).
- `revision: OrderByEnum` Revision when entity was lastly changed.

### CreateContactRelationLabelInput (input)

Field values of a new ContactRelationLabel record.

- `clientMutationId: String` Optional 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).
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `contactRelation: CreateContactRelationInput!` Contact relationship being labelled.
- `contactRelationId: ID!` Id of the contact relationship.
- `contactRelationTypeId: ID!` Id of the relationship type.
- `revision: Int` Revision when entity was lastly changed.

### CreateOrUpdateContactRelationLabelInput (input)

Field values of a ContactRelationLabel record to create, or to update when its id is set.

- `clientMutationId: String` Optional 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).
- `id: ID` Unique identifier of entity.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `contactRelation: CreateContactRelationInput` Contact relationship being labelled.
- `contactRelationId: ID` Id of the contact relationship.
- `contactRelationTypeId: ID` Id of the relationship type.
- `revision: Int` Revision when entity was lastly changed.

### DeleteContactRelationLabelInput (input)

Id of the ContactRelationLabel record to delete.

- `clientMutationId: String` Optional 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).
- `id: ID!` Unique identifier of entity.

### UpdateContactRelationLabelInput (input)

Id of a ContactRelationLabel record and the field values to change.

- `clientMutationId: String` Optional 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).
- `id: ID!` Unique identifier of entity.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `contactRelation: CreateContactRelationInput` Contact relationship being labelled.
- `contactRelationId: ID` Id of the contact relationship.
- `contactRelationTypeId: ID` Id of the relationship type.
- `revision: Int` Revision when entity was lastly changed.

### BulkUpdateContactRelationLabelPayload (object)

Result of the bulkUpdateContactRelationLabel mutation.

- `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed.

### CreateContactRelationLabelPayload (object)

Result of the createContactRelationLabel mutation.

- `contactRelationLabel: ContactRelationLabelEntity` The created record.
- `clientMutationId: String` Optional 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).

### DeleteContactRelationLabelPayload (object)

Result of the deleteContactRelationLabel mutation.

- `contactRelationLabel: ContactRelationLabelEntity` The deleted record.
- `clientMutationId: String` Optional 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).

### UpdateContactRelationLabelPayload (object)

Result of the updateContactRelationLabel mutation.

- `contactRelationLabel: ContactRelationLabelEntity` The updated record.
- `clientMutationId: String` Optional 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).

Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file.

## Example

```graphql
query FirstContactRelationLabels {
  entities {
    contactRelationLabel {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}
```

```bash
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstContactRelationLabels { entities { contactRelationLabel { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'
```