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

# entities.activityRelation

Read activity relation records with the activityRelation repository, and change them with the activity relation mutations. Same records as the REST ActivityRelations entity.

REST: [ActivityRelations](https://developers.coevera.com/reference/rest/activity-relations.md).

## Queries

- `getById(entityId: ID!): ActivityRelationEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [ActivityRelationEntity!]!` 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: ActivityRelationFilterInput, orderBy: [ActivityRelationOrderByInput!], includeDeleted: Boolean): [ActivityRelationEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: ActivityRelationFilterInput, orderBy: [ActivityRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): ActivityRelationEntityConnection` 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

- `createActivityRelation(input: CreateActivityRelationInput!, validationLevel: [ValidationLevel!]): CreateActivityRelationPayload` Create one record.
- `updateActivityRelation(input: UpdateActivityRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateActivityRelationPayload` Update fields.
- `bulkUpdateActivityRelation(input: [CreateOrUpdateActivityRelationInput!]!, deleteInput: [DeleteActivityRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateActivityRelationPayload` Create or update many; per-item results.
- `deleteActivityRelation(input: DeleteActivityRelationInput!): DeleteActivityRelationPayload` Soft-delete.

## Types

### ActivityRelationEntity (object)

Link of a task or an appointment to a record it concerns, such as an account, contact, lead, opportunity, project or quote.

- `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.
- `account: AccountEntity` Account the activity is linked to, or empty when not linked to an account.
- `appointment: AppointmentEntity` Appointment side of the link. Set when activityId resolves to an Appointment; otherwise empty.
- `task: TaskEntity` Task side of the link. Set when activityId resolves to a Task; otherwise empty.
- `contact: ContactEntity` Contact the activity is linked to, or empty when not linked to a contact.
- `customEntity: CustomEntityEntity` Custom entity record the activity is linked to, or empty.
- `lead: LeadEntity` Lead the activity is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty.
- `oppty: OpportunityEntity` Opportunity the activity is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty.
- `project: ProjectEntity` Project the activity is linked to, or empty when not linked to a project.
- `projectObjective: ProjectObjectiveEntity` Project objective the activity advances, or empty.
- `quote: QuoteEntity` Quote the activity is linked to, or empty when not linked to a quote.
- `accountId: ID` Id of the linked account.
- `activityId: ID!` Id of the appointment or task on this link.
- `contactId: ID` Id of the linked contact.
- `customEntityId: ID` Id of the linked custom entity record.
- `leadOpptyId: ID` Id of the lead or opportunity the activity is linked to, or empty when not linked.
- `projectId: ID` Id of the linked project.
- `projectObjectiveId: ID` Id of the project objective the activity advances, or empty when it is not linked to one.
- `quoteId: ID` Id of the linked quote.
- `sortOrder: Int` Display order of the activity within its project objective. Required only when projectId is set.
- `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.

### ActivityRelationEntityConnection (object)

Paginated list of ActivityRelation records.

- `pageInfo: PageInfo!` Pagination data for this connection.
- `edges: [ActivityRelationEntityEdge]!` Contains the nodes in this connection.
- `totalCount: Int` Total number of items in the connection.

### ActivityRelationEntityEdge (object)

A Relay edge containing a `ActivityRelationEntity` and its cursor.

- `node: ActivityRelationEntity` The item at the end of the edge
- `cursor: String!` A cursor for use in pagination

### ActivityRelationFilterInput (input)

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

- `OR: [ActivityRelationFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [ActivityRelationFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: ActivityRelationFilterInput` 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.
- `accountId: EntityFilterStringField` Id of the linked account.
- `activityId: EntityFilterStringField` Id of the appointment or task on this link.
- `contactId: EntityFilterStringField` Id of the linked contact.
- `customEntityId: EntityFilterStringField` Id of the linked custom entity record.
- `leadOpptyId: EntityFilterStringField` Id of the lead or opportunity the activity is linked to, or empty when not linked.
- `projectId: EntityFilterStringField` Id of the linked project.
- `projectObjectiveId: EntityFilterStringField` Id of the project objective the activity advances, or empty when it is not linked to one.
- `quoteId: EntityFilterStringField` Id of the linked quote.
- `sortOrder: EntityFilterNumberField` Display order of the activity within its project objective. Required only when projectId is set.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `account: AccountFilterInput` Account the activity is linked to, or empty when not linked to an account. Matches records where a related record meets these conditions.
- `appointment: AppointmentFilterInput` Appointment side of the link. Set when activityId resolves to an Appointment; otherwise empty. Matches records where a related record meets these conditions.
- `task: TaskFilterInput` Task side of the link. Set when activityId resolves to a Task; otherwise empty. Matches records where a related record meets these conditions.
- `contact: ContactFilterInput` Contact the activity is linked to, or empty when not linked to a contact. Matches records where a related record meets these conditions.
- `customEntity: CustomEntityFilterInput` Custom entity record the activity is linked to, or empty. Matches records where a related record meets these conditions.
- `lead: LeadFilterInput` Lead the activity is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions.
- `oppty: OpportunityFilterInput` Opportunity the activity is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions.
- `project: ProjectFilterInput` Project the activity is linked to, or empty when not linked to a project. Matches records where a related record meets these conditions.
- `projectObjective: ProjectObjectiveFilterInput` Project objective the activity advances, or empty. Matches records where a related record meets these conditions.
- `quote: QuoteFilterInput` Quote the activity is linked to, or empty when not linked to a quote. Matches records where a related record meets these conditions.

### ActivityRelationOrderByInput (input)

Sorting of ActivityRelation 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.
- `account: [AccountOrderByNestedInput!]` Account the activity is linked to, or empty when not linked to an account. Sorts by fields of the related record, listed in order of priority.
- `appointment: [AppointmentOrderByNestedInput!]` Appointment side of the link. Set when activityId resolves to an Appointment; otherwise empty. Sorts by fields of the related record, listed in order of priority.
- `task: [TaskOrderByNestedInput!]` Task side of the link. Set when activityId resolves to a Task; otherwise empty. Sorts by fields of the related record, listed in order of priority.
- `contact: [ContactOrderByNestedInput!]` Contact the activity is linked to, or empty when not linked to a contact. Sorts by fields of the related record, listed in order of priority.
- `customEntity: [CustomEntityOrderByNestedInput!]` Custom entity record the activity is linked to, or empty. Sorts by fields of the related record, listed in order of priority.
- `lead: [LeadOrderByNestedInput!]` Lead the activity is linked to. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority.
- `oppty: [OpportunityOrderByNestedInput!]` Opportunity the activity is linked to. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority.
- `project: [ProjectOrderByNestedInput!]` Project the activity is linked to, or empty when not linked to a project. Sorts by fields of the related record, listed in order of priority.
- `projectObjective: [ProjectObjectiveOrderByNestedInput!]` Project objective the activity advances, or empty. Sorts by fields of the related record, listed in order of priority.
- `quote: [QuoteOrderByNestedInput!]` Quote the activity is linked to, or empty when not linked to a quote. Sorts by fields of the related record, listed in order of priority.
- `accountId: OrderByEnum` Id of the linked account.
- `activityId: OrderByEnum` Id of the appointment or task on this link.
- `contactId: OrderByEnum` Id of the linked contact.
- `customEntityId: OrderByEnum` Id of the linked custom entity record.
- `leadOpptyId: OrderByEnum` Id of the lead or opportunity the activity is linked to, or empty when not linked.
- `projectId: OrderByEnum` Id of the linked project.
- `projectObjectiveId: OrderByEnum` Id of the project objective the activity advances, or empty when it is not linked to one.
- `quoteId: OrderByEnum` Id of the linked quote.
- `sortOrder: OrderByEnum` Display order of the activity within its project objective. Required only when projectId is set.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### CreateActivityRelationInput (input)

Field values of a new ActivityRelation 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.
- `projectObjective: CreateProjectObjectiveInput` Project objective the activity advances, or empty.
- `accountId: ID` Id of the linked account.
- `activityId: ID!` Id of the appointment or task on this link.
- `contactId: ID` Id of the linked contact.
- `customEntityId: ID` Id of the linked custom entity record.
- `leadOpptyId: ID` Id of the lead or opportunity the activity is linked to, or empty when not linked.
- `projectId: ID` Id of the linked project.
- `projectObjectiveId: ID` Id of the project objective the activity advances, or empty when it is not linked to one.
- `quoteId: ID` Id of the linked quote.
- `sortOrder: Int` Display order of the activity within its project objective. Required only when projectId is set.
- `revision: Int` Revision when entity was lastly changed.

### CreateOrUpdateActivityRelationInput (input)

Field values of an ActivityRelation 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.
- `projectObjective: CreateProjectObjectiveInput` Project objective the activity advances, or empty.
- `accountId: ID` Id of the linked account.
- `activityId: ID` Id of the appointment or task on this link.
- `contactId: ID` Id of the linked contact.
- `customEntityId: ID` Id of the linked custom entity record.
- `leadOpptyId: ID` Id of the lead or opportunity the activity is linked to, or empty when not linked.
- `projectId: ID` Id of the linked project.
- `projectObjectiveId: ID` Id of the project objective the activity advances, or empty when it is not linked to one.
- `quoteId: ID` Id of the linked quote.
- `sortOrder: Int` Display order of the activity within its project objective. Required only when projectId is set.
- `revision: Int` Revision when entity was lastly changed.

### DeleteActivityRelationInput (input)

Id of the ActivityRelation 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.
- `activityId: ID` Id of the appointment or task on this link.
- `leadOpptyId: ID` Id of the lead or opportunity the activity is linked to, or empty when not linked.

### ProjectObjectiveOrderByNestedInput (input)

Sorting by a field of the related ProjectObjective 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.
- `name: OrderByEnum` Name of the entity and its default text representation.
- `projectId: OrderByEnum` Id of the project this objective belongs to. Set on create; cannot be changed afterwards.
- `sortOrder: OrderByEnum` Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### UpdateActivityRelationInput (input)

Id of an ActivityRelation 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.
- `projectObjective: CreateProjectObjectiveInput` Project objective the activity advances, or empty.
- `accountId: ID` Id of the linked account.
- `activityId: ID` Id of the appointment or task on this link.
- `contactId: ID` Id of the linked contact.
- `customEntityId: ID` Id of the linked custom entity record.
- `leadOpptyId: ID` Id of the lead or opportunity the activity is linked to, or empty when not linked.
- `projectId: ID` Id of the linked project.
- `projectObjectiveId: ID` Id of the project objective the activity advances, or empty when it is not linked to one.
- `quoteId: ID` Id of the linked quote.
- `sortOrder: Int` Display order of the activity within its project objective. Required only when projectId is set.
- `revision: Int` Revision when entity was lastly changed.

### BulkUpdateActivityRelationPayload (object)

Result of the bulkUpdateActivityRelation mutation.

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

### CreateActivityRelationPayload (object)

Result of the createActivityRelation mutation.

- `activityRelation: ActivityRelationEntity` 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).

### DeleteActivityRelationPayload (object)

Result of the deleteActivityRelation mutation.

- `activityRelation: ActivityRelationEntity` 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).

### UpdateActivityRelationPayload (object)

Result of the updateActivityRelation mutation.

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