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

# entities.accountRelationLabel

Read account relation label records with the accountRelationLabel repository, and change them with the account relation label mutations. Same records as the REST AccountRelationLabels entity.

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

## Queries

- `getById(entityId: ID!): AccountRelationLabelEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [AccountRelationLabelEntity!]!` 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: AccountRelationLabelFilterInput, orderBy: [AccountRelationLabelOrderByInput!], includeDeleted: Boolean): [AccountRelationLabelEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: AccountRelationLabelFilterInput, orderBy: [AccountRelationLabelOrderByInput!], includeDeleted: Boolean): [AccountRelationLabelEntity!]!` 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

- `createAccountRelationLabel(input: CreateAccountRelationLabelInput!, validationLevel: [ValidationLevel!]): CreateAccountRelationLabelPayload` Create one record.
- `updateAccountRelationLabel(input: UpdateAccountRelationLabelInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateAccountRelationLabelPayload` Update fields.
- `bulkUpdateAccountRelationLabel(input: [CreateOrUpdateAccountRelationLabelInput!]!, deleteInput: [DeleteAccountRelationLabelInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateAccountRelationLabelPayload` Create or update many; per-item results.
- `deleteAccountRelationLabel(input: DeleteAccountRelationLabelInput!): DeleteAccountRelationLabelPayload` Soft-delete.

## Types

### AccountRelationLabelEntity (object)

Relationship type assigned to a link between two accounts, such as Partner or Supplier.

- `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.
- `accountRelation: AccountRelationEntity` Account relationship being labelled.
- `accountRelationType: AccountRelationTypeEntity` Type of the relationship (e.g. partner, supplier).
- `accountRelationId: ID!` Id of the account relationship.
- `accountRelationTypeId: 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.

### AccountRelationLabelFilterInput (input)

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

- `OR: [AccountRelationLabelFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [AccountRelationLabelFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: AccountRelationLabelFilterInput` 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.
- `accountRelationId: EntityFilterStringField` Id of the account relationship.
- `accountRelationTypeId: EntityFilterStringField` Id of the relationship type.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `accountRelation: AccountRelationFilterInput` Account relationship being labelled. Matches records where a related record meets these conditions.
- `accountRelationType: AccountRelationTypeFilterInput` Type of the relationship (e.g. partner, supplier). Matches records where a related record meets these conditions.

### AccountRelationLabelOrderByInput (input)

Sorting of AccountRelationLabel 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.
- `accountRelation: [AccountRelationOrderByNestedInput!]` Account relationship being labelled. Sorts by fields of the related record, listed in order of priority.
- `accountRelationType: [AccountRelationTypeOrderByNestedInput!]` Type of the relationship (e.g. partner, supplier). Sorts by fields of the related record, listed in order of priority.
- `accountRelationId: OrderByEnum` Id of the account relationship.
- `accountRelationTypeId: OrderByEnum` Id of the relationship type.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### AccountRelationOrderByNestedInput (input)

Sorting by a field of the related AccountRelation 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.
- `account1Id: OrderByEnum` Id of the first related account.
- `account2Id: OrderByEnum` Id of the second related account.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### AccountRelationTypeOrderByNestedInput (input)

Sorting by a field of the related AccountRelationType 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 account-to-account relationship type (e.g. Partner, Supplier).
- `revision: OrderByEnum` Revision when entity was lastly changed.

### CreateAccountRelationLabelInput (input)

Field values of a new AccountRelationLabel 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.
- `accountRelation: CreateAccountRelationInput!` Account relationship being labelled.
- `accountRelationId: ID!` Id of the account relationship.
- `accountRelationTypeId: ID!` Id of the relationship type.
- `revision: Int` Revision when entity was lastly changed.

### CreateOrUpdateAccountRelationLabelInput (input)

Field values of an AccountRelationLabel 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.
- `accountRelation: CreateAccountRelationInput` Account relationship being labelled.
- `accountRelationId: ID` Id of the account relationship.
- `accountRelationTypeId: ID` Id of the relationship type.
- `revision: Int` Revision when entity was lastly changed.

### DeleteAccountRelationLabelInput (input)

Id of the AccountRelationLabel 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.

### UpdateAccountRelationLabelInput (input)

Id of an AccountRelationLabel 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.
- `accountRelation: CreateAccountRelationInput` Account relationship being labelled.
- `accountRelationId: ID` Id of the account relationship.
- `accountRelationTypeId: ID` Id of the relationship type.
- `revision: Int` Revision when entity was lastly changed.

### BulkUpdateAccountRelationLabelPayload (object)

Result of the bulkUpdateAccountRelationLabel mutation.

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

### CreateAccountRelationLabelPayload (object)

Result of the createAccountRelationLabel mutation.

- `accountRelationLabel: AccountRelationLabelEntity` 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).

### DeleteAccountRelationLabelPayload (object)

Result of the deleteAccountRelationLabel mutation.

- `accountRelationLabel: AccountRelationLabelEntity` 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).

### UpdateAccountRelationLabelPayload (object)

Result of the updateAccountRelationLabel mutation.

- `accountRelationLabel: AccountRelationLabelEntity` 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 FirstAccountRelationLabels {
  entities {
    accountRelationLabel {
      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 FirstAccountRelationLabels { entities { accountRelationLabel { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'
```