Skip to main content

Field Reference

in FQL Guide
Authors list
Published: 4 Nov 2021|Last updated: 7 Nov 2022

Articles

Name

Operator

Values

article

ID


article.status

String comparison

published, archived, hidden

article.hidden_status

String

unpublished, draft, deleted, spam

article.person

ID ref

Ref to people

article.language

ID ref

Ref to languages

article.categories

ID ref

Ref list to article_categories

article.labels

String comparison

Sub-search from labels_articles

article.title

String equation


article.content

String equation


article.date_created

Date

DATE() with allowed params

article.date_updated

Date

DATE() with allowed params

article.date_published

Date

DATE() with allowed params

article.data.*

CustomField


Chats

Name

Operator

Values

chat.id

ID


chat.status

String comparison

open, ended

chat.department

ID ref

Ref to departments

chat.brand

ID ref

Ref to brands

chat.agent

ID ref

Ref to people

chat.person

ID ref

Ref to people

chat.person_name

String equation


chat.person_email

String equation


chat.subject

String equation


chat.date_created

Date

DATE() with allowed params

chat.data.*

CustomField


Community

Name

Operator

Values

community_topic.id

ID


community_topic.status

String comparison

published, archived, hidden

community_topic.hidden_status

String comparison

unpublished, draft, deleted, spam

community_topic.person

ID ref

Ref to people

community_topic.language

ID ref

Ref to languages

community_topic.forum

ID ref

Ref to community_forums

community_topic.title

String equation


community_topic.content

String equation


community_topic.labels

String

Sub-search from labels_community_topics

community_topic.date_created

Date

DATE() with allowed params

community_topic.date_updated

Date

DATE() with allowed params

community_topic.date_published

Date

DATE() with allowed params

community_topic.data.*

CustomField


Files

Name

Operator

Values

download.id

ID


download.status

String comparison

published, archived, hidden

download.hidden_status

String comparison

unpublished, draft, deleted, spam

download.person

ID ref

Ref to people

download.language

ID ref

Ref to languages

download.category

ID ref

Ref to download_categories

download.labels

String

Sub-search from labels_downloads

download.title

String equation


download.content

String equation


download.date_created

Date

DATE() with allowed params

download.date_updated

Date

DATE() with allowed params

download.date_published

Date

DATE() with allowed params

download.data.*

CustomField


News

Name

Operator

Values

news.id

ID


news.status

String comparison

published, archived , hidden

news.hidden_status

String comparison

unpublished, draft, deleted, spam

news.person

ID ref

Ref to people

news.language

ID ref

Ref to languages

news.category

ID ref

Ref to news_categories

news.labels

String

Sub-search from labels_news

news.title

String equation


news.content

String equation


news.date_created

Date

DATE() with allowed params

news.date_updated

Date

DATE() with allowed params

news.date_published

Date

DATE() with allowed params

Organizations

Name

Operator

Values

organization.id

ID


organization.name

String equation


organization.summary

String equation


organization.importance

String


organization.members

ID ref

Ref to people

organization.email_domains

String comparison

Sub-search from organization_email_domains

organization.labels

String comparison

Sub-search from labels_organizations

organization.date_created

Date

DATE() with allowed params

organization.data.*

CustomField


Person

Name

Operator

Values

person.id

ID


person.is_agent

Boolean

true, false, 1, 0

person.organization

ID ref

Ref to organizations

person.language

ID ref

Ref to languages

person.brand

ID ref

Ref to brands

person.user_groups

ID ref

List ref to person2usergroups

person.name



person.first_name

String equation


person.last_name

String equation


person.primary_email

String comparison

Sub-search from people_emails

person.phones

String comparison

Sub-search from phone_numbers

person.emails

String comparison

Sub-search from people_emails

person.labels

String comparison

Sub-search from labels_people

person.date_created

Date

DATE() with allowed params

person.date_last_login

Date

DATE() with allowed params

person.data.*

CustomField


Tickets

Name

Operator

Values

ticket.id

ID


ticket.ref

String equation


ticket.status

String comparison


ticket.ticket_status_id

ID ref

Ref to ticket_statuses

ticket.is_hold

Boolean

true, false, 1, 0

ticket.urgency

String comparison

number casted to string

ticket.organization

ID ref

Ref to organizations

ticket.department

ID ref

Ref to departments

ticket.person

ID ref

Ref to people

ticket.users

ID ref

Ref to people, use to query if user cc or ticket owner

ticket.person.email_address

-

HAS ANYWHERE("foo_bar"), HAS STARTS_WITH("foo_bar") & HAS ENDS_WITH("foo_bar")

ticket.agent

ID ref

Ref to people

ticket.agent_team

ID ref

Ref to agent_teams

ticket.followers

ID ref

Ref to people

ticket.participants

ID ref

Ref to people

ticket.language

ID ref

Ref to languages

ticket.product

ID ref

Ref to products

ticket.category

ID ref

Ref to ticket_categories

ticket.priority

ID ref

Ref to ticket_priorities

ticket.workflow

ID ref

Ref to ticket_workflows

ticket.brand

ID ref

Ref to brands

ticket.email_account

ID ref

Ref to email_accounts

ticket.labels

String

Sub-search from labels_tickets

ticket.problems

ID ref

Ref to problems

ticket.person.email_address

String comparison

Sub-search from people_emails

ticket.subject

String equation

ticket.subject has anywhere('xyz')

ticket.messages

String equation

Sub-search from tickets_messages

ticket.starred

String comparison

String color from tickets_flagged

ticket.date_created

Date

DATE() with params

ticket.date_resolved

Date

DATE() with params

ticket.date_archived

Date

DATE() with params

ticket.date_last_agent_reply

Date

DATE() with params

ticket.date_last_user_reply

Date

DATE() with params

ticket.agent_waiting

Date

DATE() with params

ticket.user_waiting

Date

DATE() with params

ticket.slas

ID ref

Ref to ticket_slas via SLAs functions

passingSlas()

Function

Predicate function, does not accept params

warningSlas()

Function

Predicate function, does not accept params

failedSlas()

Function

Predicate function, does not accept params

ticket.data.*

CustomField


ticket.organization.data.*

CustomField


ticket.person.data.*

CustomField


HelpfulUnhelpful

1 of 2 people found this page helpful

next pageFQL Examples
previous pageOperators

Please log in or register to submit a comment.