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

# entities.allowedLeadType

Read allowed lead type records with the allowedLeadType repository, and change them with the allowed lead type mutations. Same records as the REST AllowedLeadTypes entity.

REST: [AllowedLeadTypes](https://developers.coevera.com/reference/rest/allowed-lead-types.md).

## Queries

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

- `createAllowedLeadType(input: CreateAllowedLeadTypeInput!, validationLevel: [ValidationLevel!]): CreateAllowedLeadTypePayload` Create one record.
- `updateAllowedLeadType(input: UpdateAllowedLeadTypeInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateAllowedLeadTypePayload` Update fields.
- `bulkUpdateAllowedLeadType(input: [CreateOrUpdateAllowedLeadTypeInput!]!, deleteInput: [DeleteAllowedLeadTypeInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateAllowedLeadTypePayload` Create or update many; per-item results.
- `deleteAllowedLeadType(input: DeleteAllowedLeadTypeInput!): DeleteAllowedLeadTypePayload` Soft-delete.

## Types

### AllowedLeadTypeEntity (object)

Lead type that a user role is allowed to use.

- `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.
- `leadType: LeadTypeEntity` Lead type the user role can use.
- `masterRight: MasterRightEntity` User role granted access to the lead type.
- `leadTypeId: ID!` Id of the lead type the user role can use.
- `masterRightId: ID!` Id of the user role.
- `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.

### AllowedLeadTypeEntityConnection (object)

Paginated list of AllowedLeadType records.

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

### AllowedLeadTypeEntityEdge (object)

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

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

### AllowedLeadTypeFilterInput (input)

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

- `OR: [AllowedLeadTypeFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [AllowedLeadTypeFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: AllowedLeadTypeFilterInput` 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.
- `leadTypeId: EntityFilterStringField` Id of the lead type the user role can use.
- `masterRightId: EntityFilterStringField` Id of the user role.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `leadType: LeadTypeFilterInput` Lead type the user role can use. Matches records where a related record meets these conditions.
- `masterRight: MasterRightFilterInput` User role granted access to the lead type. Matches records where a related record meets these conditions.

### AllowedLeadTypeOrderByInput (input)

Sorting of AllowedLeadType 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.
- `leadType: [LeadTypeOrderByNestedInput!]` Lead 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 lead type. Sorts by fields of the related record, listed in order of priority.
- `leadTypeId: OrderByEnum` Id of the lead type the user role can use.
- `masterRightId: OrderByEnum` Id of the user role.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### CreateAllowedLeadTypeInput (input)

Field values of a new AllowedLeadType 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.
- `leadTypeId: ID!` Id of the lead type the user role can use.
- `masterRightId: ID!` Id of the user role.
- `revision: Int` Revision when entity was lastly changed.

### CreateOrUpdateAllowedLeadTypeInput (input)

Field values of an AllowedLeadType 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.
- `leadTypeId: ID` Id of the lead type the user role can use.
- `masterRightId: ID` Id of the user role.
- `revision: Int` Revision when entity was lastly changed.

### DeleteAllowedLeadTypeInput (input)

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

### UpdateAllowedLeadTypeInput (input)

Id of an AllowedLeadType 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.
- `leadTypeId: ID` Id of the lead type the user role can use.
- `masterRightId: ID` Id of the user role.
- `revision: Int` Revision when entity was lastly changed.

### BulkUpdateAllowedLeadTypePayload (object)

Result of the bulkUpdateAllowedLeadType mutation.

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

### CreateAllowedLeadTypePayload (object)

Result of the createAllowedLeadType mutation.

- `allowedLeadType: AllowedLeadTypeEntity` 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).

### DeleteAllowedLeadTypePayload (object)

Result of the deleteAllowedLeadType mutation.

- `allowedLeadType: AllowedLeadTypeEntity` 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).

### UpdateAllowedLeadTypePayload (object)

Result of the updateAllowedLeadType mutation.

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