GraphQL RepositoriesleadType

`entities.leadType`

Read lead type records with the leadType repository, and change them with the lead type mutations. Same records as the REST LeadTypes entity.

Example: first three lead type recordsGraphQLcURL

query FirstLeadTypes {
  entities {
    leadType {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id name modified } }
      }
    }
  }
}

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

Queries

Fields of entities { leadType { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	LeadTypeEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[LeadTypeEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: LeadTypeFilterInput, orderBy: [LeadTypeOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[LeadTypeEntity!]!
QUERY	`getByCriteria`(filter: LeadTypeFilterInput, orderBy: [LeadTypeOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	LeadTypeEntityConnection
QUERY	`getPublished`(limit: Int, offset: Int, filter: LeadTypeFilterInput, orderBy: [LeadTypeOrderByInput!], includeDeleted: Boolean) Returns the published records that match the filter, paged with limit and offset.	[LeadTypeEntity!]!
QUERY	`getDrafts`(filter: LeadTypeFilterInput, orderBy: [LeadTypeOrderByInput!]) Returns the records that match the filter, with pending unpublished changes applied where a draft exists.	[LeadTypeEntity!]!
QUERY	`getDraftById`(entityId: ID!) Returns the record with the given id, with its pending unpublished changes applied when a draft exists.	LeadTypeEntity!
QUERY	`getByLeadProcess`(leadProcessId: UUID!) Returns the lead type that uses the given lead process, or null when none does.	LeadTypeEntity

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.

LeadTypeEntity object 20 fields: id, isDeleted, modified, …

Lead type that classifies leads and defines their forms and the lead process they follow.

Field	Type	Description
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`leadProcess`	LeadProcessEntity	Lead process (pipeline) this lead type follows.
`formEdit`	JSONString!	JSON definition of the form layout used by the UI when creating or editing leads of this type. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host
`formLost`	JSONString!	JSON definition of the form shown when archiving (losing) a lead of this type. Used to capture reason of close and any required closing fields. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host
`formLostEnabled`	Boolean!	True when the lost form is required on archiving leads of this type.
`isReadonly`	Boolean!	True when the lead type is system-managed and cannot be edited or deleted by users.
`leadProcessId`	ID!	Id of the lead process that leads of this type follow.
`name`	String!	Name of the entity and its default text representation.
`settings`	EntityTypeSettings!	Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. This payload conforms to the `EntityTypeSettings` JSON Schema: GET /api/v100/rest/schemas/EntityTypeSettings.json on your region's API host
`isPublished`	Boolean	True when the entity configuration is published; false while it exists only as an unpublished draft.
`revision`	Int	Revision when entity was lastly changed.
`hasDraft`	Boolean	True when the record has unpublished draft changes, including pending translation changes, that can be published.
`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.
`formEditApi`	Form	Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost).
`canChangeReadonly`	Boolean	False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise.
`formLostApi`	Form	Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost).
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

LeadTypeEntityConnection object pageInfo: PageInfo!, edges: [LeadTypeEntityEdge]!, totalCount: Int

Paginated list of LeadType records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[LeadTypeEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

LeadTypeEntityEdge object node: LeadTypeEntity, cursor: String!

A Relay edge containing a LeadTypeEntity and its cursor.

Field	Type	Description
`node`	LeadTypeEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

LeadTypeFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

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

Input field	Type	Description
`OR`	[LeadTypeFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[LeadTypeFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	LeadTypeFilterInput	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.
`formLostEnabled`	Boolean	True when the lost form is required on archiving leads of this type.
`isReadonly`	Boolean	True when the lead type is system-managed and cannot be edited or deleted by users.
`leadProcessId`	EntityFilterStringField	Id of the lead process that leads of this type follow.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`isPublished`	Boolean	True when the entity configuration is published; false while it exists only as an unpublished draft.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`leadProcess`	LeadProcessFilterInput	Lead process (pipeline) this lead type follows. Matches records where a related record meets these conditions.

LeadTypeOrderByInput input Asc or Desc per field

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

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`leadProcess`	[LeadProcessOrderByNestedInput!]	Lead process (pipeline) this lead type follows. Sorts by fields of the related record, listed in order of priority.
`formLostEnabled`	OrderByEnum	True when the lost form is required on archiving leads of this type.
`isReadonly`	OrderByEnum	True when the lead type is system-managed and cannot be edited or deleted by users.
`leadProcessId`	OrderByEnum	Id of the lead process that leads of this type follow.
`name`	OrderByEnum	Name of the entity and its default text representation.
`isPublished`	OrderByEnum	True when the entity configuration is published; false while it exists only as an unpublished draft.
`revision`	OrderByEnum	Revision when entity was lastly changed.