Zendesk Connector Objects

Name	Description
AccessLogs	Query access logs in Zendesk.
AccountSettings	Query and update Account Settings in Zendesk.
ActivityStream	Query ActivityStreams in Zendesk.
AppLocations	Query AppLocations in Zendesk.
Apps	Query Apps in Zendesk.
ArticleAttachments	Query and Delete Acticle Attachment in Zendesk.
ArticleComments	Create, Update, Delete and Query the Article Comments in Zendesk.
ArticleLabels	Create, delete, and query Article Labels in Zendesk.
Articles	Create, Update, Archive and query Acticles in Zendesk.
ArticleTranslations	Create, Update, Delete and Query the Translations for Articles in Zendesk.
Attachments	Show ticket attachments in Zendesk.
Attributes	Create, Update, Delete and Query the Attributes in Zendesk. An attribute in Zendesk refers to a skill type. Skill types are categories of skills.
AttributeValues	Create, Update, Delete and Query the Attribute Values in Zendesk. An attribute value in this API refers to a skill. Skills are associated with an agent and determine the agent's suitability to solve a ticket.
AuditLogs	Query audit logs in Zendesk.
Automations	Create, update, delete, and query Automations in Zendesk.
Bookmarks	Create, Delete and Query the Bookmarks in Zendesk.
Brands	Create, delete, update, and query Brands in Zendesk.
Calls	A complete list of information on inbound and outbound calls from your Zendesk Talk instance.
Categories	Create, update, delete, and query Categories in Zendesk.
CategoryTranslations	Create, Update, Delete and Query the Translations for Categories in Zendesk.
Collaborators	Query Collaborators in Zendesk.
ContentSubscriptions	Create, Update, Delete and Query the Content Subscriptions in Zendesk. Users can subscribe to sections, articles, community posts, and community topics.
ContentTags	Create, Update, Delete and Query the Content Tags in Zendesk.
CustomAgentRoles	Create, Update, Delete and Query CustomAgentRoles in Zendesk.
CustomObjectField	The view specifies all the attributes of a custom object property.
CustomObjects	Create, delete, update, and query Custom Objects in Zendesk.
CustomTicketStatuses	Create, update, and query custom ticket statuses in zendesk.
GroupMemberships	Create, delete, and query Group Memberships in Zendesk.
Groups	Create, update, delete, and query Groups in Zendesk.
GroupSlaPolicies	Create, Update, Delete and Query Group SLA Policies in Zendesk.
Holidays	Create, update, delete, and query Schedules in Zendesk.
JiraLinks	View and create links between your Jira and Zendesk instances.
JobStatus	A status record is created when somebody kicks off a job such as updating multiple tickets. You can access the job status data for an hour after a particular job is created, after which the data is no longer available.
Locales	Query Locales in Zendesk.
Macros	Create, update, delete, and query Macros in Zendesk.
ManagementPermissionGroups	Create, Update, Delete and Query the Management Permission Groups in Zendesk. A management permission group defines which agents can create, update, archive, and publish articles. It consists of a set of privileges, each of which is mapped to a user segment. Agents receive whichever privileges are associated with the user segments they belong to.
MonitoredTwitterHandles	Query Monitored Twitter handles in Zendesk.
OrganizationFields	Create, update, delete, and query Organization Fields in Zendesk.
OrganizationFieldsRelationshipFilterAll	Query OrganizationFields RelationshipFilterAll Filter with Logical AND.
OrganizationFieldsRelationshipFilterAny	Query OrganizationFields RelationshipFilterAny Filter with Logical OR.
OrganizationMemberships	Create, delete, and query Organization Memberships in Zendesk.
Organizations	Create, delete, update, and query Organizations in Zendesk.
OrganizationSubscriptions	Create, delete, and query Organization Subscriptions in Zendesk.
PostComments	Query, Insert, Update and Delete PostComments in Zendesk.
Posts	Query, Insert, Update and Delete Posts in Zendesk.
Requests	Query Requests in Zendesk.
RequestsCollaborators	The Collaborator ids of users currently CC'ed on the ticket.
ResourceCollections	Query Resource Collections in Zendesk.
SatisfactionRatings	Create and query Requests in Zendesk.
SatisfactionReasons	Query the Satisfaction Reasons in Zendesk.
Schedules	Create, update, delete and query Schedules in Zendesk.
Sections	Create, update, delete, and query Sections in Zendesk.
SectionTranslations	Create, Update, Delete and Query the Translations for Sections in Zendesk.
Sessions	Query and delete Sessions in Zendesk.
SharingAgreements	Create, update, delete, and query SharingAgreements in Zendesk.
SideConversationEvents	Query Side Conversations events in Zendesk. The messages that make up a side conversation are recorded as events.
SideConversationEventsMessage	Query Side Conversations events message in Zendesk.
SideConversationEventsMessageTo	Query the list of participants, the message was sent to.
SideConversationParticipants	Query Side Conversation Participants in Zendesk.
SideConversations	Create, update and query Side Conversations in Zendesk.
SlaPolicies	Create, update, delete, and query SlaPolicies in Zendesk.
SlaPoliciesFilterAll	Query SlaPolicies Filter with Logical AND.
SlaPoliciesFilterAny	Query SlaPolicies Filter with Logical OR.
SlaPoliciesMetrics	Query SlaPoliciesMetrics that describes the metric targets for each value of the priority field.
SupportAddresses	Create, update, delete, and query Support Addresses in Zendesk.
SuspendedTickets	Query and delete Suspended Tickets in Zendesk.
TargetFailures	Query Target failures in Zendesk.
Targets	Create, Update, Delete and Query Targets in Zendesk.
TicketAudits	Query TicketAudits in Zendesk.
TicketComments	Query TicketComments belonging to a specified ticket in Zendesk.
TicketEmailCCs	Query any users cc'd on the ticket in Zendesk.
TicketEvents	Query TicketEvents in Zendesk.
TicketFields	Create, update, delete, and query TicketFields in Zendesk.
TicketFieldsRelationshipFilterAll	Query TicketFields RelationshipFilterAll Filter with Logical AND.
TicketFieldsRelationshipFilterAny	Query TicketFields RelationshipFilterAny Filter with Logical OR.
TicketForms	Create, update, delete, and query Ticket Forms in Zendesk.
TicketMetricEvents	Queries TicketMetricEvents in Zendesk.
TicketMetrics	Query TicketMetrics in Zendesk.
TicketRelatedInformation	Query Ticket related information in Zendesk.
Tickets	Create, update, delete, and query Tickets.
TicketSkips	Create and Query the TicketSkips in Zendesk. A skip is a record of when an agent skips over a ticket without responding to the end user. Skips are typically recorded while a play-only agent is in Guided mode.
TicketsCollaborators	The Collaborator id of users currently CC'ed on the ticket.
TicketsFollowers	The ids of agents currently following the ticket.
TicketsFollowups	The ids of the followups created from ticket.
TicketsMacros	List of macros to be recorded in the ticket audit.
TicketsSatisfactionRatings	The satisfaction rating of the ticket, if it exists, or the state of satisfaction.
TicketsSharingAgreements	The sharing agreements used for ticket.
TicketsTags	The tags applied to the ticket.
TicketsViasources	List ViaSources for the Ticket.
Topics	Query, Insert, Update and Delete Topics in Zendesk.
Translations	Create, Update, Delete and Query the Translations in Zendesk. This table is deprecated, and is being replaced by the ArticleTranslations, CategoryTranslations, and SectionTranslations tables.
TriggerCategories	Create, update, delete, and query Trigger Categories in Zendesk.
Triggers	Create, update, delete, and query Triggers in Zendesk.
UserEvents	Query events for a given Zendesk user.
UserFields	Create, update, delete, and query User Fields.
UserFieldsRelationshipFilterAll	Query UserFields RelationshipFilterAll Filter with Logical AND.
UserFieldsRelationshipFilterAny	Query UserFields RelationshipFilterAny Filter with Logical OR.
UserIdentities	Create, update, delete, and query User Identities.
UserRelatedInformation	Query UserRelatedInformation in Zendesk.
Users	Create, update, delete, and query Users in Zendesk.
UserSegments	Create, Update, Delete and Query the User Segments in Zendesk. A user segment defines who can view the content of a section or topic.
UserSubscriptions	Query the user subscriptions in Zendesk.
Views	Create, update, delete and query views in Zendesk.
ViewsConditionsAll	Query views conditions with logical AND.
ViewsConditionsAny	Query views conditions with logical OR.
Votes	Create, Delete and Query the Votes in Zendesk. Votes represents positive and negative opinions of users about articles, article comments, posts or post comments.

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	Unique identifier for the access log.
UserId	Long	True	No	ID of the user who made the request.
Status	Integer	True	No	HTTP status code of the response.
Method	String	True	No	HTTP method of the request. Possible values: GET, POST, PUT, DELETE.
IpAddress	String	True	No	IP address of the user who made the request.
Timestamp	Datetime	True	No	ISO 8601 formatted string representing the time of the request.
Url	String	True	No	URL of the request.
Graphql	String	True	No	Optional details if the request was a GraphQL query.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
BrandingHeaderColor	String	False	No	HEX of the header color.
BrandingPageBackgroundColor	String	True	No	HEX of the page background color.
BrandingTabBackgroundColor	String	True	No	HEX of tab background color.
BrandingTextColor	String	True	No	HEX of the text color, usually matched to contrast well with header_color.
BrandingHeaderLogoUrl	String	True	No	The URL for the custom header logo.
BrandingFaviconUrl	String	True	No	The URL for the custom favicon.
AppsUse	Boolean	True	No	The account can use apps.
AppsCreatePrivate	Boolean	True	No	The account can create private apps.
TicketsCommentsPublicByDefault	Boolean	True	No	Comments from agents are public by default.
TicketsIsFirstCommentPrivateEnabled	Boolean	True	No	Allow first comment on tickets to be private.
TicketsListNewestCommentsFirst	Boolean	True	No	When viewing a ticket, show the newest comments and events first.
TicketsCollaboration	Boolean	True	No	CCs may be added to a ticket.
TicketsPrivateAttachments	Boolean	True	No	Users must login to access attachments.
TicketsEmailAttachments	Boolean	True	No	Attachments should be sent as real attachments when under the size limit.
TicketsAgentCollision	Boolean	True	No	Clients should provide an indicator when a ticket is being viewed by another agent.
TicketsMaximumPersonalViewsToList	Integer	True	No	Maximum number of personal Views clients should display in menus.
TicketsTagging	Boolean	True	No	Tickets may be tagged.
TicketsMarkdownTicketComments	Boolean	True	No	Whether agent comments should be processed with Markdown.
TicketsEmojiAutocompletion	Boolean	True	No	Whether agent comments should allow for Emoji rendering.
TicketsAgentTicketDeletion	Boolean	False	No	Whether agents can delete tickets.
ChatEnabled	Boolean	True	No	Chat is enabled.
ChatMaximumRequests	Integer	True	No	The maximum number of chat requests an agent may handle at one time.
ChatWelcomeMessage	String	True	No	The message automatically sent to end-users when they begin chatting with an agent.
TwitterShortenUrl	String	True	No	Possible values: always, optional, never.
GSuiteHasGoogleApps	Boolean	True	No	Whether has google apps.
GSuiteHasGoogleAppsAdmin	Boolean	False	No	Account has at least one G Suite admin.
VoiceEnabled	Boolean	True	No	Whether Voice is enabled.
VoiceMaintenance	Boolean	True	No	.
VoiceLogging	Boolean	True	No	.
VoiceOutboundEnabled	Boolean	True	No	.
VoiceAgentConfirmationWhenForwarding	Boolean	True	No	.
VoiceAgentWrapUpAfterCalls	Boolean	True	No	.
VoiceMaximumQueueSize	Integer	True	No	.
VoiceMaximumQueueWaitTime	Integer	True	No	.
VoiceOnlyDuringBusinessHours	Boolean	True	No	.
VoiceRecordingsPublic	Boolean	True	No	.
VocieUkMobileForwarding	Boolean	True	No	.
UsersTagging	Boolean	True	No	Users may be tagged.
UsersTimeZoneSelection	Boolean	True	No	Whether user can view time zone for profile.
UsersLanguageSelection	Boolean	True	No	Whether to display language drop down for a user.
UsersAgentCreatedWelcomeEmails	Boolean	True	No	Whether a user created by an agent receives a welcome email.
UsersEndUserPhoneNumberValidation	Boolean	False	No	Whether a user's phone number is validated.
GooddataAdvancedAnalytics_Enabled	Boolean	True	No	GoodData Advanced Analytics is enabled.
BrandsDefaultBrandId	Long	False	No	The id of the brand that is assigned to tickets by default.
BrandsRequireBrandOnNewTickets	Boolean	True	No	Require agents to select a brand before saving tickets.
StatisticsForum	Boolean	True	No	Allow users to view forum statistics.
StatisticsSearch	Boolean	True	No	Allow users to view search statistics.
BillingBackend	String	True	No	Backend Billing system either internal or zuora.
ActiveFeaturesOnHoldStatus	Boolean	True	No	Account can use status hold.
ActiveFeaturesUserTagging	Boolean	True	No	Enable user tags.
ActiveFeaturesTicketTagging	Boolean	True	No	Allow tagging tickets.
ActiveFeaturesTopicSuggestion	Boolean	True	No	Allow topic suggestions in tickets.
ActiveFeaturesVoice	Boolean	True	No	Voice support.
ActiveFeaturesFacebookLogin	Boolean	True	No	Facebook login.
ActiveFeaturesGoogleLogin	Boolean	True	No	Google login.
ActiveFeaturesTwitterLogin	Boolean	True	No	Twitter login.
ActiveFeaturesForumAnalytics	Boolean	True	No	Forum and search analytics.
ActiveFeaturesBusinessHours	Boolean	False	No	Business hours.
ActiveFeaturesAgentForwarding	Boolean	True	No	Agent forwarding.
ActiveFeaturesChat	Boolean	True	No	Chat.
ActiveFeaturesChatAboutMyTicket	Boolean	True	No	Chat about my ticket.
ActiveFeaturesCustomerSatisfaction	Boolean	False	No	Customer satisfaction.
ActiveFeaturesSatisfactionPrediction	Boolean	False	No	Satisfaction Prediction.
ActiveFeaturesCsatReasonCode	Boolean	True	No	Csat reason code.
ActiveFeaturesScreencasts	Boolean	True	No	.
ActiveFeaturesMarkdown	Boolean	True	No	Markdown in ticket comments.
ActiveFeaturesLanguageDetection	Boolean	True	No	Language detection.
ActiveFeaturesBccArchiving	Boolean	True	No	Account has a bcc_archive_address set.
ActiveFeaturesAllowCcs	Boolean	True	No	Allow ccs.
ActiveFeaturesAdvancedAnalytics	Boolean	True	No	Advanced analytics.
ActiveFeaturesInsights	Boolean	True	No	Insights.
ActiveFeaturesSandbox	Boolean	True	No	Account has a sandbox.
ActiveFeaturesSuspendedTicketNotification	Boolean	True	No	Suspended ticket notification.
ActiveFeaturesTwitter	Boolean	True	No	Account monitors at least one Twitter handle.
ActiveFeaturesFacebook	Boolean	True	No	Account is actively linked to at least one Facebook page.
ActiveFeaturesFeedbackTabs	Boolean	True	No	Feedback tab has been configured before.
ActiveFeaturesDynamicContents	Boolean	True	No	Account has at least one dynamic content.
ActiveFeaturesLightAgents	Boolean	True	No	Account has at least one light agent.
ActiveFeaturesTicketForms	Boolean	True	No	Ticket forms.
ActiveFeaturesUserOrgFields	Boolean	True	No	User org fields.
ActiveFeaturesIsAbusive	Boolean	True	No	Account exceeded trial limits.
ActiveFeaturesRichContentInEmails	Boolean	True	No	Account supports incoming HTML email.
ApiAcceptedApiAgreement	Boolean	False	No	Account has accepted the API agreement.
ApiPasswordAccess	Boolean	False	No	Allow the account to use the API with username/password.
ApiTokenAccess	Boolean	False	No	Allow the account to use the API with API tokens.
TicketFormsInstructions	String	False	No	.
RawTicketFormsInstructions	String	True	No	.
LotusPrefer	Boolean	True	No	Prefers the current version of Zendesk Support rather than Zendesk Classic.
RulesMacroMostUsed	Boolean	False	No	Display the most-used macros in the Apply macro list. Defaults to true.
RulesMacroOrder	String	False	No	Default macro display order. Possible values are alphabetical or position.
LimitsAttachmentSize	Integer	True	No	The maximum ticket attachment file size (in bytes).
MetricsAccountSize	String	True	No	An account size category computed from the number of billable agents.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Automatically assigned upon creation.
Title	String	False		No	Description of this activity.
Verb	String	False		No	The type of activity. Can be tickets.assignment, tickets.comment, or tickets.priority_increase.
UserId	Long	False	Users.Id	No	The user this activity pertains to.
ActorId	Long	False	Users.Id	No	The user this activity pertains to.
CreatedAt	Datetime	False		No	When this locale was created.
UpdatedAt	Datetime	False		No	When this locale last got updated.
Url	String	False		No	The API url of this activity.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	Internal location ID.
Name	String	False	No	The unique location key.
ProductCode	Integer	False	No	Internal product ID.
HostApplication	String	False	No	The unique host application key.
Orderable	Boolean	False	No	True if reordering has any effect.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Integer	True	No	The id of the app.
Name	String	True	No	The name of the app.
State	String	True	No	Publication state for the app on the Zendesk Marketplace.
Version	String	True	No	The version of the app.
FrameworkVersion	String	True	No	The app framework version for which the app was written.
Parameters	String	True	No	The parameters for the app.
Plans	String	True	No	Payment plans for the app.
RatingTotalCount	Integer	True	No	Total count of the ratings of the app.
RatingAvergae	Integer	True	No	Average rating of the app.
RatingCount	String	True	No	Rating count of the app.
SingleInstall	Boolean	True	No	Whether or not this app can only be installed once.
DefaultLocale	String	True	No	The default locale for translations for the app.
FeatureColor	String	True	No	Hexadecimal color value used to feature the app on the Zendesk Marketplace.
GoogleAnalyticsCode	String	True	No	Universal Google Analytics (UA-) tracking id for the app's detail page on the Zendesk Marketplace.
RemoteInstallationUrl	String	True	No	URL for the app's installation instructions.
Products	String	True	No	Zendesk products supported by the app.
Categories	String	True	No	Zendesk Marketplace categories to which the app belongs.
Collections	String	True	No	Zendesk Marketplace collections to which the app belongs.
StripePublishableKey	String	True	No	Publishable key for the app developer's Stripe account.
CreatedAt	Datetime	True	No	When the app was created.
UpdatedAt	Datetime	True	No	When the app was last updated.
TermsConditionsUrl	String	True	No	URL for the app's terms and conditions.
AppOrganizationId	Integer	True	No	Organization Id that submitted the app to the Zendesk Marketplace.
AppOrganizationName	String	True	No	Organization name that submitted the app to the Zendesk Marketplace.
AppOrganizationEmail	String	True	No	Organization email that submitted the app to the Zendesk Marketplace.
AppOrganizationWebsite	String	True	No	Organization website that submitted the app to the Zendesk Marketplace.
AppOrganizationCountryCode	String	True	No	Organization country code that submitted the app to the Zendesk Marketplace.
AppOrganizationStripeAccountId	String	True	No	Organization Stripe account id that submitted the app to the Zendesk Marketplace.
Locations	String	True	No	Location ids for the app.
DatePublished	Datetime	True	No	When the app was published on the Zendesk Marketplace.
HasThirdPartyPricing	Boolean	True	No	Third-party pricing information for the app.
ThirdPartyPricingUrl	String	True	No	Third-party pricing url for the app.
OwnerId	Long	True	No	The app developer id corresponding to the app.
AuthorName	String	True	No	The app author's name.
AuthorEmail	String	True	No	The app author's email.
AuthorUrl	String	True	No	The app author's URL.
ShortDescription	String	True	No	The short description of the app in the Zendesk Marketplace.
LongDescription	String	True	No	The app's long description in the Zendesk Marketplace.
InstallationInstructions	String	True	No	Instructions for installing the app.
RawLongDescription	String	True	No	The raw long description for the app in the Zendesk Marketplace.
RawInstallationInstructions	String	True	No	The raw installation instructions.
Visibility	String	True	No	The app is a private app, which is only visible to your account, or a public app. An example value is 'private'.
Promoted	Boolean	True	No	Whether or not the app is a promoted app in the Zendesk Marketplace.
Featured	Boolean	True	No	Whether or not the app is featured in the Zendesk Marketplace.
Paid	Boolean	True	No	If true, the app is a paid app.
Deprecated	Boolean	True	No	If true, the app is deprecated.
Obsolete	Boolean	True	No	If true, the app is obsolete.
Installable	Boolean	True	No	Whether or not the app can be installed.
MarketingOnly	Boolean	True	No	If true, the app is an integration app.
SmallIcon	String	True	No	The url for the small logo for the app.
LargeIcon	String	True	No	The large icon url for an app.
Screenshots	String	True	No	Screenshots for the app when displayed in the Zendesk Marketplace.
InstallationCount	Integer	True	No	Current number of installations of the app.
Owned	Boolean	False	Yes	Boolean value that needs to be set when you want to lists the apps owned by the current account.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Assigned ID when the article attachment is created.
ArticleId	Long	True	Articles.Id	No	The associated article, if present.
ContentType	String	True		No	The file type. Example: image/png.
ContentUrl	String	True		No	URL where the attachment file can be downloaded.
CreatedAt	Datetime	True		No	The time the article attachment was created.
DisplayFileName	String	True		No	display_file_name.
FileName	String	True		No	The file name.
Inline	Boolean	True		No	The attached file is shown in the admin interface for inline attachments. Its URL can be referenced in the article's HTML body. Inline attachments are image files directly embedded in the article body. If false, the attachment is listed in the list of attachments. The default value is false.
RelativePath	String	True		No	relative_path.
Size	Integer	True		No	The attachment file size in bytes.
UpdatedAt	Datetime	True		No	The time the article attachment was last updated.
Url	String	True		No	The URL of the article attachment.
AttachmentsResponse	String	True		No	Content of the attachments.
Locale	String	False		Yes	The locale that the article attachments is being displayed in.
IsInline	Boolean	False		Yes	Boolean value that represents Article is inline or not.
Base64EncodedResponse	Boolean	False		Yes	Raw response gets converted into base64encoded.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when the comment is created.
AuthorId	Long	False	No	The id of the author of this comment. Writable on create by Help Center managers.
Body	String	False	No	The comment made by the author.
Locale	String	False	No	The locale in which this comment was made.
url	String	True	No	The API url of this comment.
HtmlUrl	String	True	No	The url at which the comment is presented in Help Center.
NonAuthorEditorId	Long	True	No	The user id of whoever performed the most recent (if any) non-author edit. A non-author edit consists of an edit make by a user other than the author that creates or updates the body or author_id. Note that only edits made after May 17, 2021 will be reflected in this field. If no non-author edits have occured since May 17, 2021, then this field will be null.
NonAuthorUpdatedAt	Datetime	True	No	When the comment was last edited by a non-author user.
SourceId	Long	True	No	The id of the item on which this comment was made.
SourceType	String	True	No	The type of the item on which this comment was made. Currently only supports 'Article'.
VoteCount	Integer	True	No	The total number of upvotes and downvotes.
VoteSum	Integer	True	No	The sum of upvotes (+1) and downvotes (-1), which may be positive or negative.
CreatedAt	Datetime	False	No	The time the comment was created. Writable on create by Help Center managers.
UpdatedAt	Datetime	True	No	The time at which the comment was last updated.
ArticleId	Long	False	Yes	The Id of the Article.
UserId	Long	False	Yes	The Id of the User.
NotifySubscribers	Boolean	False	Yes	Supplying a notify_subscribers property with a value of false will prevent subscribers to the comment's article from receiving a comment creation email notification. This can be helpful when creating many comments at a time.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when the label is created.
Name	String	False	No	The actual name of the label.
CreatedAt	Datetime	True	No	The time at which the label was created.
UpdatedAt	Datetime	True	No	The time at which the label was last updated.
Url	String	True	No	The API url of this label.
ArticleId	Long	False	Yes	The unique ID of the article.
Locale	String	False	Yes	The locale the item is displayed in.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when the article is created.
AuthorId	Long	True	No	The id of the user who wrote the article (set to the user who made the request on create by default).
Body	String	False	No	HTML body of the article. Unsafe tags and attributes may be removed before display. For a list of safe tags and attributes, see Allowing unsafe HTML in Help Center articles in Zendesk help.
CommentsDisabled	Boolean	False	No	True if comments are disabled; false otherwise.
CreatedAt	Datetime	True	No	The time the article was created.
Draft	Boolean	False	No	True if the translation for the current locale is a draft; false otherwise. false by default. Can be set when creating but not when updating. For updating, see Translations.
EditedAt	Datetime	True	No	The time the article was last edited in its displayed locale.
HtmlUrl	String	True	No	The url of the article in Help Center.
LabelNames	String	False	No	An array of label names associated with this article. By default no label names are used. Only available on certain plans.
Locale	String	False	No	The locale that the article is being displayed in.
Outdated	Boolean	True	No	Deprecated. Always false because the source translation is always the most up-to-date translation.
OutdatedLocales	String	True	No	Locales in which the article was marked as outdated.
PermissionGroupId	Long	False	No	The id of the permission group which defines who can edit and publish this article.
Position	Integer	False	No	The position of this article in the article list. 0 by default.
Promoted	Boolean	False	No	True if this article is promoted; false otherwise. false by default.
SectionId	Long	False	No	The id of the section to which this article belongs.
SourceLocale	String	True	No	The source (default) locale of the article.
Title	String	False	No	The title of the article.
UpdatedAt	Datetime	True	No	The time the article was last updated.
Url	String	True	No	The API url of the article.
UserSegmentId	Long	False	No	The id of the user segment which defines who can see this article. Set to null to make it accessible to everyone.
VoteCount	Integer	True	No	The total number of upvotes and downvotes.
VoteSum	Integer	True	No	The sum of upvotes (+1) and downvotes (-1), which may be positive or negative.
CategoryId	Long	False	Yes	Id of the categories.
UserId	Long	False	Yes	Id of author.
StartTime	Datetime	False	Yes	Start Time.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when a translation is created.
CreatedById	Long	True		No	The id of the user who created the translation.
UpdatedById	Long	True		No	The id of the user who last updated the translation.
SourceId	Long	True		No	The id of the item that has this translation.
Title	String	False		No	The title of the translation.
Body	String	False		No	HTML body of the translation. Empty by default.
Draft	Boolean	False		No	True if the translation is a draft; false otherwise. False by default.
HtmlUrl	String	True		No	The url of the translation in Help Center.
Locale	String	False		No	The locale of the translation.
Outdated	Boolean	False		No	True if the translation is outdated; false otherwise. False by default.
SourceType	String	True		No	The type of the item that has this translation. Can be article, section, or category.
Url	String	True		No	The API url of the translation.
CreatedAt	Datetime	True		No	The time at which the translation was created.
UpdatedAt	Datetime	True		No	The time at which the translation was last updated.
ArticleId	Long	False	Articles.Id	No	Id of the associated article.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
AttachmentId [KEY]	Long	False		No	Automatically assigned when the ticket is created.
TicketId	Integer	False	Tickets.Id	No	The id of the ticket the comment belongs to.
CommentId	Long	False	TicketComments.Id	No	The id of the comment the attachment belongs to.
FileName	String	False		No	The name of the form.
ContentUrl	String	False		No	A full URL where the attachment image file can be downloaded.
ContentType	String	False		No	The content type of the image.
Size	Integer	False		No	The size of the image file in bytes.
Inline	Boolean	False		No	If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false.
UpdatedAt	Datetime	False		Yes	The time of the attachment was updated.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	Automatically assigned when an attribute is created.
Name	String	False	No	The name of the attribute.
url	String	True	No	URL of the attribute.
CreatedAt	Datetime	True	No	When this record was created.
UpdatedAt	Datetime	True	No	When this record was last updated.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	Automatically assigned when an attribute value is created.
AttributeId	String	False	Attributes.Id	No	The Attribute Id.
Name	String	False		No	The name of the attribute value.
url	String	True		No	URL of the attribute.
CreatedAt	Datetime	True		No	When this record was created.
UpdatedAt	Datetime	True		No	When this record was last updated.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The id automatically assigned upon creation.
ActorId	Long	True	No	Id of the user or system that initiated the change.
SourceId	Long	True	No	The id of the item being audited.
ActorName	String	True	No	Name of the user or system that initiated the change.
ActionLabel	String	True	No	Localized string of action field.
SourceType	String	True	No	Item type being audited.
SourceLabel	String	True	No	The name of the item being audited.
Action	String	True	No	Type of change made. Possible values are create, destroy, exported, login, and update.
ChangeDescription	String	True	No	The description of the change that occurred.
IpAddress	String	True	No	The IP address of the user doing the audit.
CreatedAt	Datetime	True	No	The time the audit got created.
Url	String	True	No	The URL to access the audit log.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when created.
Title	String	False	No	The title of the automation.
Active	Boolean	False	No	Whether the automation is active.
Position	Integer	False	No	The position of the automation.
ConditionsAll	String	False	No	An object that describes the conditions under which the automation will execute.
ConditionsAny	String	False	No	An object that describes the conditions under which the automation will execute.
Actions	String	False	No	An object describing what the automation will do.
CreatedAt	Datetime	True	No	The time the automation was created.
UpdatedAt	Datetime	True	No	The time of the last update of the automation.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when the bookmark is created.
Ticket	String	True	No	The ticket object.
url	String	True	No	The API url of this bookmark.
CreatedAt	Datetime	True	No	The time the bookmark was created.
TicketId	Integer	False	Yes	The time the bookmark was created.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	Automatically assigned when the brand is created.
Name	String	False	No	The name of the brand.
CreatedAt	Datetime	False	No	The time the brand was created.
UpdatedAt	Datetime	False	No	The time of the last update of the brand.
BrandUrl	String	False	No	The url of the brand.
HasHelpCenter	Boolean	False	No	If the brand has a Help Center.
HelpCenterState	String	False	No	The state of the Help Center: enabled, disabled, or restricted.
Active	Boolean	False	No	If the brand is set as active.
Default	Boolean	False	No	Is the brand the default brand for this account.
LogoId	Long	False	No	The id of logo image for this brand.
LogoUrl	String	False	No	The url of logo image for this brand.
LogoFileName	String	False	No	The name of logo image for this brand.
LogoContentUrl	String	False	No	The content url of logo image for this brand.
LogoMappedContentUrl	String	False	No	The mapped content url of logo image for this brand.
LogoContentType	String	False	No	The content type of logo image for this brand.
LogoSize	Integer	False	No	The size of logo image for this brand.
TicketFormIds	String	False	No	The ids of ticket forms that are available for use by a brand.
HostMapping	String	False	No	The hostmapping to this brand, if any (only admins view this key).
Subdomain	String	False	No	The subdomain of the brand.
SignatureTemplate	String	False	No	The signature template for a brand.
Url	String	False	No	The API url of this brand.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id	Long	False	No	Call id.
AgentId	Long	False	No	The id of the first agent who picked up the call.
CallCharge	String	False	No	Total charge for the call. String representation of a decimal number with six decimal places.
CallGroupId	Long	False	No	The id number of the group the call was last placed in before completion.
CallRecordingConsent	String	False	No	Call recording consent value configured for the phone number. Allowed values are always, opt_in, opt_out or never.
CallRecordingConsentAction	String	False	No	Call recording consent option selected by the caller. Allowed values are caller_opted_in, caller_opted_out or null.
CallRecordingConsentKeypress	String	False	No	Keypress the caller chose to give their call recording consent option. Allowed values are 3 or null.
Callback	Boolean	False	No	True if the call was initiated by a callback request from the customer.
CallbackSource	String	False	No	The source of the callback request. Allowed values are null, queue or web_widget.
CompletionStatus	String	False	No	Status of the call. Allowed values are completed, abandoned_in_queue, abandoned_in_ivr, abandoned_in_voicemail, abandoned_on_hold or pending_voicemail.
ConsultationTime	String	False	No	Sum of how long in seconds agents consulted with each other while the customer was on hold.
CreatedAt	Datetime	False	No	When the call object was created.
CustomerId	Long	False	No	Customer Id.
CustomerRequestedVoicemail	Boolean	False	No	The customer requested to be directed to voicemail instead of waiting for an agent to answer.
DefaultGroup	Boolean	False	No	The call was answered by an agent who is a member of the calls default group, if group routing is used.
Direction	String	False	No	Inbound or outbound. The agent or customer who initialized the call.
Duration	Integer	False	No	Call duration in seconds.
ExceededQueueWaitTime	Boolean	False	No	The customer exceeded the maximum queue wait time and did not speak with an agent.
HoldTime	Integer	False	No	Sum of how long in seconds the customer was placed on hold by an agent(s).
IvrAction	String	False	No	Menu action that was used by the caller in the IVR menu selection. Possible values: null (if IVR is not used), menu, voicemail, group, phone_number, textback, invalid (returned for an invalid keypress).
IvrDestinationGroupName	String	False	No	Name of the group that received the call through IVR routing. null if IVR is disabled.
IvrHops	Integer	False	No	How many menu options the customer went through in IVR before talking to an agent. null if IVR is disabled.
IvrRoutedTo	String	False	No	Phone number where call was routed to by IVR. Example: +1311123456789. null if IVR is disabled.
IvrTimeSpent	Integer	False	No	How long in seconds the customer spent in IVR. Null if IVR is disabled.
MinutesBilled	Integer	False	No	Minutes billed.
Line	String	False	No	Line.
LineId	Long	False	No	Line Id.
NotRecordingTime	Integer	False	No	How long in seconds spent not recording on the call.
OutsideBusinessHours	Boolean	False	No	The call was received outside business hours.
Overflowed	Boolean	False	No	True if the call overflowed.
OverflowedTo	String	False	No	The phone number that the call overflowed to. null if overflowed is false.
PhoneNumber	String	False	No	Talk phone associated with the call. If this a digital line, the digital line nickname. Example: +1311123456789.
PhoneNumberId	Integer	False	No	Talk phone number id.
QualityIssues	String	False	No	A summary of the call's quality issues related to the call provided to Zendesk from Twilio. Until the information is made available by Twilio, the array contains information_not_available. If there are no issues, the array contains none. Other possible values: one or more of silence, high_jitter, high_packet_loss, high_pdd, high_latency.
RecordingControlInteractions	Integer	False	No	The amount of times agents have paused or resumed a recording on the call.
RecordingTime	Integer	False	No	How long in seconds spent recording on the call.
TalkTime	Integer	False	No	Sum of how long in seconds the customer was in conference with an agent(s). If a call is not accepted by an agent this will be 0.
TicketId	Integer	False	No	The id of the ticket related to the call.
TimeToAnswer	Integer	False	No	How long in seconds the customer waited for an agent to answer after hearing the Available agents greeting.
UpdatedAt	Datetime	False	No	When the call object was last created.
Voicemail	Boolean	False	No	If true, the call was a voicemail.
WaitTime	Integer	False	No	How long in seconds the customer was in the call before an agent answered.
WrapUpTime	Integer	False	No	Sum of how long in seconds the agent(s) spent in wrap up.
StartTime	Datetime	False	Yes	Start Time.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when creating categories.
Name	String	False	No	The name of the category.
Description	String	False	No	The description of the category.
Locale	String	False	No	The locale where the category is displayed.
CreatedAt	Datetime	True	No	The time at which the category was created.
UpdatedAt	Datetime	True	No	The time at which the category was last updated.
Url	String	True	No	The API url of this category.
HtmlUrl	String	True	No	The url of this category in Help Center.
Outdated	Boolean	True	No	Whether the category is out of date.
Position	Integer	False	No	The position of this category relative to other categories.
SourceLocale	String	True	No	The source (default) locale of the category.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when a translation is created.
CreatedById	Long	True		No	The id of the user who created the translation.
UpdatedById	Long	True		No	The id of the user who last updated the translation.
SourceId	Long	True		No	The id of the item that has this translation.
Title	String	False		No	The title of the translation.
Body	String	False		No	HTML body of the translation. Empty by default.
Draft	Boolean	False		No	True if the translation is a draft; false otherwise. False by default.
HtmlUrl	String	True		No	The url of the translation in Help Center.
Locale	String	False		No	The locale of the translation.
Outdated	Boolean	False		No	True if the translation is outdated; false otherwise. False by default.
SourceType	String	True		No	The type of the item that has this translation. Can be article, section, or category.
Url	String	True		No	The API url of the translation.
CreatedAt	Datetime	True		No	The time at which the translation was created.
UpdatedAt	Datetime	True		No	The time at which the translation was last updated.
CategoryId	Long	False	Categories.Id	No	Id of the associated category.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Automatically assigned when the ticket is created.
TicketId [KEY]	Integer	False	Tickets.Id	No	The id of the ticket.
Email	String	False		No	The primary email address of the collaborator. Writeable on create only. On update, a secondary email is added.
Name	String	False		No	The name of the collaborator.
Role	String	False		No	The role of the collaborator. Possible values are end-collaborator, agent, or admin.
Active	Boolean	False		No	False if the collaborator has been deleted.
OrganizationId	Long	False	Organizations.Id	No	The id of the organization the collaborator is associated with.
Alias	String	False		No	An alias displayed to end users.
Verified	Boolean	False		No	If the identity of the collaborator has been verified or not.
ChatOnly	Boolean	False		No	Whether or not the collaborator is a chat-only agent.
CreatedAt	Datetime	False		No	The time the collaborator was created.
UpdatedAt	Datetime	False		No	The time the collaborator was last updated.
CustomRoleId	Long	False	CustomAgentRoles.Id	No	A custom role if the collaborator is an agent on the Enterprise plan.
RoleType	String	False		No	The role id of the collaborator. 0 for custom agents, 1 for light agent and 2 for chat agent.
DefaultGroupId	Long	False	Groups.Id	No	The id of the default group of the collaborator. Can only be set on create, not on update.
Details	String	False		No	Any details you want to store about the collaborator, such as an address.
ExternalId	String	False		No	A unique identifier from another system.
LastLoginAt	Datetime	False		No	The last time the collaborator signed in to Zendesk Support.
Locale	String	False		No	The locale of the collaborator.
LocaleId	Long	False	Locales.Id	No	The language identifier of the collaborator.
Moderator	Boolean	False		No	Designates whether the collaborator has forum moderation capabilities.
Notes	String	False		No	Any notes you want to store about the collaborator.
OnlyPrivateComments	Boolean	False		No	True if the collaborator can only create private comments.
Phone	String	False		No	The primary phone number of the collaborator.
PhotoId	Long	False		No	Automatically assigned when the attachment is created.
PhotoFileName	String	False		No	The name of the image file.
PhotoContentUrl	String	False		No	A full URL where the attachment image file can be downloaded.
PhotoContentType	String	False		No	The content type of the image. Example value: image/png.
PhotoSize	Integer	False		No	The size of the image file in bytes.
PhotoThumbnailsId	Long	False		No	.
PhotoThumbnailsFileName	String	False		No	.
PhotoThumbnailsContentUrl	String	False		No	.
PhotoThumbnailsContentType	String	False		No	.
PhotoThumbnailsSize	Integer	False		No	.
PhotoInline	Boolean	False		No	If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false.
RestrictedAgent	Boolean	False		No	If the agent has any restrictions; false for admins and unrestricted agents, true for other agents.
Shared	Boolean	False		No	If the collaborator is shared from a different Zendesk Support instance. Ticket sharing accounts only.
SharedAgent	Boolean	False		No	If the collaborator is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only.
Signature	String	False		No	The signature of the collaborator. Only agents and admins can have signatures.
Suspended	Boolean	False		No	If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end collaborator portal.
Tags	String	False		No	The tags of the collaborator. Only present if your account has collaborator tagging enabled.
TicketRestriction	String	False		No	Specifies which tickets the collaborator has access to. Possible values are: organization, groups, assigned, requested, null.
TimeZone	String	False		No	The time zone of the collaborator.
TwoFactorAuthEnabled	Boolean	False		No	If two factor authentication is enabled.
Url	String	False		No	The API url of the collaborator.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when the subscription is created.
UserId	String	False	Users.Id	No	The id of the user who has this subscription.
ContentId	Long	True		No	The id of the subscribed item.
ContentType	String	True		No	The type of the subscribed item.
IncludeComments	Boolean	False		No	Subscribe also to article comments/post comments. Only for section/topic subscriptions.
Locale	String	False		No	The locale of the subscribed item.
SourceLocale	String	False		No	Used only for Create Section Subscription and Create Article Subscription, where it's mandatory. Selects the locale of the content to be subscribed.
Url	String	True		No	The API url of the subscription.
CreatedAt	Datetime	True		No	The time at which the subscription was created.
UpdatedAt	Datetime	True		No	The time at which the subscription was last updated.
TopicId	Long	False		Yes	Id of the Topic.
PostId	Long	False		Yes	Id of the Post.
SectionId	Long	False		Yes	Id of the Section.
ArticleId	Long	False		Yes	Id of the Article.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	Automatically assigned when the content tag is created.
Name	String	False	No	The name of the content tag.
CreatedAt	Datetime	True	No	When the content tag was created.
UpdatedAt	Datetime	True	No	When the content tag was last updated.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned upon creation.
Name	String	False	No	Name of the custom role.
Description	String	False	No	A description of the role.
CreatedAt	Datetime	True	No	The time the record was created.
UpdatedAt	Datetime	True	No	The time the record was last updated.
ConfigurationChatAccess	Boolean	False	No	Boolean value that checks whether or not the agent has access to Chat.
ConfigurationEndUserProfileAccess	String	False	No	What the agent can do with end-user profiles. Allowed values are edit, edit-within-org, full, readonly.
ConfigurationForumAccess	String	False	No	The kind of access the agent has to Guide. Allowed values are edit-topics, full, readonly.
ConfigurationForumAccessRestrictedContent	Boolean	False	No	Configuration Forum Access Restricted Content.
ConfigurationMacroAccess	String	False	No	What the agent can do with macros. Allowed values are full, manage-group, manage-personal, readonly.
ConfigurationManageBusinessRules	Boolean	False	No	Whether or not the agent can create and manage schedules and view rules analysis.
ConfigurationManageDynamicContent	Boolean	False	No	Whether or not the agent can access dynamic content.
ConfigurationManageExtensionsAndChannels	Boolean	False	No	Whether or not the agent can manage channels and extensions.
ConfigurationManageFacebook	Boolean	False	No	Whether or not the agent can manage facebook pages.
ConfigurationOrganizationEditing	Boolean	False	No	Whether or not the agent can add or modify organizations.
ConfigurationReportAccess	String	False	No	What the agent can do with reports. Allowed values are full, none, readonly.
ConfigurationTicketAccess	String	False	No	What kind of tickets the agent can access. Allowed values are all, assigned-only, within-groups, within-groups-and-public-groups, within-organization.
ConfigurationTicketCommentAccess	String	False	No	What kind of tickets the agent can access. Allowed values are all, assigned-only, within-groups, within-groups-and-public-groups, within-organization.
ConfigurationTicketDeletion	Boolean	False	No	Whether or not the agent can delete tickets.
ConfigurationTicketMerge	Boolean	False	No	Whether or not the agent can merge tickets.
ConfigurationTicketTagEditing	Boolean	False	No	Whether or not the agent can edit ticket tags.
ConfigurationTwitterSearchAccess	Boolean	False	No	Configuration Twitter Search Access.
ConfigurationViewAccess	String	False	No	What the agent can do with views. Allowed values are full, manage-group, manage-personal, playonly, readonly.
ConfigurationUserViewAccess	String	False	No	What the agent can do with customer lists. Allowed values are full, manage-group, manage-personal, none, readonly.
ConfigurationAssignTicketsToAnyGroup	Boolean	False	No	Whether or not the agent can assign tickets to any group.
ConfigurationCustomObjects	String	False	No	A list of custom object keys mapped to JSON objects that define the agent's permissions (scopes) for each object. Allowed values: are read, update, delete, create. The read permission is required if any other scopes are specified.
ConfigurationEndUserListAccess	String	False	No	Whether or not the agent can view lists of user profiles. Allowed values are full, none.
ConfigurationExploreAccess	String	False	No	Allowed values are edit, full, none, readonly.
ConfigurationGroupAccess	Boolean	False	No	Whether or not the agent can add or modify groups.
ConfigurationLightAgent	Boolean	False	No	Configuration Light Agent.
ConfigurationManageAutomations	Boolean	False	No	Whether or not the agent can create and manage automations.
ConfigurationManageContextualWorkspaces	Boolean	False	No	Whether or not the agent can view, add, and edit contextual workspaces.
ConfigurationManageGroupMemberships	Boolean	False	No	Whether or not the agent can create and manage group memberships.
ConfigurationManageGroups	Boolean	False	No	Whether or not the agent can create and modify groups.
ConfigurationManageOrganizationFields	Boolean	False	No	Whether or not the agent can create and manage organization fields.
ConfigurationManageOrganizations	Boolean	False	No	Whether or not the agent can create and modify organizations.
ConfigurationManageRoles	String	False	No	Whether or not the agent can create and manage custom roles with the exception of the role they're currently assigned. Doesn't allow agents to update role assignments for other agents. Allowed values are all-except-self, none.
ConfigurationManageSkills	Boolean	False	No	Whether or not the agent can create and manage skills.
ConfigurationManageSlas	Boolean	False	No	Whether or not the agent can create and manage SLAs.
ConfigurationManageSuspendedTickets	Boolean	False	No	Whether or not the agent can manage suspended tickets.
ConfigurationManageTeamMembers	String	False	No	Whether or not the agent can manage team members. Allows agents to update role assignments for other agents. Allowed values are all-with-self-restriction, readonly, none.
ConfigurationManageTicketFields	Boolean	False	No	Whether or not the agent can create and manage ticket fields.
ConfigurationManageTicketForms	Boolean	False	No	Whether or not the agent can create and manage ticket forms.
ConfigurationManageTriggers	Boolean	False	No	Whether or not the agent can create and manage triggers.
ConfigurationManageUserFields	Boolean	False	No	Whether or not the agent can create and manage user fields.
ConfigurationModerateForums	Boolean	False	No	Configuration Moderate Forums.
ConfigurationOrganizationNotesEditing	Boolean	False	No	Whether or not the agent can add or modify organization notes.
ConfigurationSideConversationCreate	Boolean	False	No	Whether or not the agent can contribute to side conversations.
ConfigurationTicketEditing	Boolean	False	No	Whether or not the agent can edit ticket properties.
ConfigurationTicketRedaction	Boolean	False	No	Whether or not the agent can redact content from tickets. Only applicable to tickets permitted by ticket_access.
ConfigurationViewDeletedTickets	Boolean	False	No	Whether or not the agent can view deleted tickets.
ConfigurationVoiceAccess	Boolean	False	No	Whether or not the agent can answer and place calls to end users.
ConfigurationVoiceDashboardAccess	Boolean	False	No	Whether or not the agent can view details about calls on the Talk dashboard.
RoleType	Integer	True	No	The user's role id. It is 0 for a custom agent.
TeamMemberCount	Integer	True	No	The number of team members assigned to this role.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
ObjectName [KEY]	String	False	No	A user-defined unique identifier.
FieldName	String	False	No	The name of the property.
Type	String	False	No	The type of the property.
Description	String	False	No	The description of the property.
Required	String	False	No	Indicates whether or not this property is required when you create a record.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
ObjectName [KEY]	String	False	No	A user-defined unique identifier. Writable on create only.
CreatedAt	Datetime	True	No	The time the object type was created.
UpdatedAt	Datetime	True	No	The time of the last update of the object type.
Version	String	False	No	The version of this schema.
Properties	String	False	No	A description of the object record, up to a maximum of 32 KB.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when the custom ticket status is created.
Active	Boolean	False	No	If true, the custom status is set to active, If false, the custom status is set to inactive.
URL	String	True	No	The label displayed to agents. Maximum length is 48 characters.
AgentLabel	String	False	No	The label displayed to agents. Maximum length is 48 characters.
Default	Boolean	False	No	If true, the custom status is set to default. If false, the custom status is set to non-default.
Description	String	False	No	The description of when the user should select this custom ticket status.
StatusCategory	String	False	No	The status category the custom ticket status belongs to.
EndUserLabel	String	False	No	The label displayed to end users. Maximum length is 48 characters.
EndUserDescription	String	False	No	The description displayed to end users.
RawAgentLabel	String	True	No	The dynamic content placeholder. If the dynamic content placeholder is not available, this is the agent_label value.
RawDescription	String	True	No	The dynamic content placeholder. If the dynamic content placeholder is not available, this is the raw_description value.
RawEndUserLabel	String	True	No	The dynamic content placeholder. If the dynamic content placeholder is not available, this is the raw_end_user_label value.
RawEndUserDescription	String	True	No	The dynamic content placeholder. If the dynamic content placeholder is not available, this is the raw_end_user_description value.
CreatedAt	Datetime	True	No	The date and time the custom ticket status was created.
UpdatedAt	Datetime	True	No	The time of the last update of the ticket field.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when the ticket is created.
UserId	Long	False	Users.Id	No	The id of an agent.
GroupId	Long	False	Groups.Id	No	The id of a group.
Default	Boolean	False		No	If true, tickets assigned directly to the agent will assume this membership's group.
CreatedAt	Datetime	True		No	The time the membership was created.
UpdatedAt	Datetime	True		No	The time of the last update of the membership.
Url	String	True		No	The API url of this record.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when the ticket is created.
Name	String	False	No	The name of the group.
CreatedAt	Datetime	True	No	The time the group was created.
UpdatedAt	Datetime	True	No	The time of the last update of the group.
Deleted	Boolean	True	No	Deleted groups get marked as such.
Url	String	True	No	The API url of this group.
UserId	Long	False	No	The user id used to query groups.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	Automatically assigned when created.
Title	String	False	No	The title of the Group SLA policy.
Position	Integer	False	No	Position of the Group SLA policy. This position determines the order in which policies are matched to tickets. If not specified, the Group SLA policy is added at the last position.
Description	String	False	No	The description of the Group SLA policy.
PolicyMetrics	String	False	No	Array of policy metric objects.
CreatedAt	Datetime	True	No	The time the Group SLA policy was created.
UpdatedAt	Datetime	True	No	The time of the last update of the Group SLA policy.
Filter	String	False	No	An object that describes the conditions a ticket must match for a Group SLA policy to be applied to the ticket.
Url	String	True	No	URL of the Group SLA policy record.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned upon creation.
ScheduleId	Long	False	Schedules.Id	No	Id of the schedule the holiday belongs to.
Name	String	False		No	Name of the holiday.
StartDate	Date	False		No	Time when the holiday starts.
EndDate	Date	False		No	Time when the holiday ends.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	True		No	Automatically assigned when the link is created.
TicketId	Integer	False	Tickets.Id	No	The id of the Zendesk ticket.
IssueId	Integer	False		No	The id of the Jira issue.
IssueKey	String	False		No	The key for the Jira issue.
CreatedAt	Datetime	True		No	The time at which the link was created.
UpdatedAt	Datetime	True		No	The time at which the link was last updated.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	False	No	Automatically assigned when the job is queued.
Total	Integer	False	No	The total number of tasks this job is batching through.
Progress	Integer	False	No	Number of tasks that have already been completed.
Status	String	False	No	The current status. One of the following: queued, working, failed, completed, killed.
Message	String	False	No	Message from the job worker, if any.
Results	String	False	No	Result data from processed tasks.
Url	String	False	No	The URL to poll for status updates.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	Automatically assigned.
Name	String	False	No	Name of the locale.
Locale	String	False	No	The locale.
CreatedAt	Datetime	False	No	When this locale was created.
UpdatedAt	Datetime	False	No	When this locale last got updated.
Url	String	False	No	The API url of the locale.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Automatically assigned when created.
Title	String	False		No	The title of the macro.
Actions	String	False		No	An object describing what the macro will do.
Active	Boolean	False		No	Useful for determining if the macro should be displayed.Only active macros if true, inactive macros if false.
Description	String	False		No	The description of the macro.
Position	Integer	False		No	The position of the macro.
Restrictions	String	False		No	Who may access this macro. Will be null when everyone in the account can access it.
CreatedAt	Datetime	False		No	The time the macro was created.
UpdatedAt	Datetime	False		No	The time of the last update of the macro.
Access	String	False		No	Only macros with given access. Possible values are personal, shared, or account.
Category	String	False		No	Only macros within given category.
GroupId	Long	False	Groups.Id	No	Only macros belonging to given group.
OnlyViewable	Boolean	False		No	Only macros that can be applied to tickets if true, All macros the current user can manage if false. Defaults to false.
Attachments	String	False		No	An array of macro attachment IDs to be associated with the macro, used in Insertion.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when the permission group is created.
BuiltIn	Boolean	True	No	Whether the permission group is built-in. Built-in permission groups cannot be modified.
Name	String	False	No	Permission group name.
Edit	String	False	No	The ids of user segments that have edit privileges. For insertion and updation provide these values separated by comma.
Publish	String	False	No	The ids of user segments that have publish privileges. For insertion and updation provide these values separated by comma.
CreatedAt	Datetime	True	No	When the permission group was created.
UpdatedAt	Datetime	True	No	When the permission group was last updated.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Automatically assigned upon creation.
ScreenName	String	False		No	Name of the locale.
TwitterUserId	Long	False		No	The country's code.
CreatedAt	Datetime	False		No	The time the handle was created.
UpdatedAt	Datetime	False		No	The time of the last update of the handle.
AvatarUrl	String	False		No	The profile image url of the handle.
Name	String	False		No	The profile name of the handle.
AllowReply	Boolean	False		No	The profile image url of the handle.
CanReply	Boolean	False		No	If replies are allowed for this handle.
BrandId	Long	False	Brands.Id	No	What brand the handle is associated with.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	Automatically assigned upon creation.
Key	String	False	No	A unique key that identifies this custom field. Required on create.This is used for updating the field and referencing in placeholders. After a field is created, you cannot change its key.
Type	String	False	No	Type of the custom field: checkbox, date, decimal, dropdown, integer, regexp, text, or textarea. After a field is created, you cannot change its type.
Title	String	False	No	The title of the custom field.
RawTitle	String	False	No	The dynamic content placeholder, if present, or the title value, if not.
Description	String	False	No	User-defined description of this field s purpose.
RawDescription	String	False	No	The dynamic content placeholder, if present, or the description value, if not.
Position	Integer	False	No	Ordering of the field relative to other fields.
Active	Boolean	False	No	If true, this field is available for use.
System	Boolean	False	No	If true, only active and position values of this field can be changed.
RegexpForValidation	String	False	No	Regular expression field only. The validation pattern for a field value to be deemed valid.
CreatedAt	Datetime	False	No	The time the ticket field was created.
UpdatedAt	Datetime	False	No	The time of the last update of the ticket field.
Tag	String	False	No	Optional for custom field of type checkbox; not presented otherwise.
CustomFieldOptions	String	False	No	Required and presented for a custom field of type dropdown.
Url	String	False	No	The URL for this resource.
RelationshipFilterAll	String	False	No	A filter definition that allows your autocomplete to filter down results with Logical AND.
RelationshipFilterAny	String	False	No	A filter definition that allows your autocomplete to filter down results with Logical OR.
RelationshipTargetType	String	False	No	A representation of what type of object the field references. Options are zen, zen, zen, or zen:custom_object. For example zen:custom_object.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
OrganizationFieldId	Long	True	OrganizationFields.Id	No	The Organization field id.
Field	String	True		No	The name of a ticket field.
Operator	String	True		No	A comparison operator.
Value	String	True		No	The value of a ticket field.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
OrganizationFieldId	Long	True	OrganizationFields.Id	No	The Organization field id.
Field	String	True		No	The name of a ticket field.
Operator	String	True		No	A comparison operator.
Value	String	True		No	The value of a ticket field.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when the membership is created.
OrganizationId	Long	False	Organizations.Id	No	The ID of the organization associated with this user, in this membership.
UserId	Long	False	Users.Id	No	The ID of the user for whom this memberships belongs.
Default	Boolean	False		No	Denotes whether this is the default organization membership for the user. If false, returns null.
CreatedAt	Datetime	False		No	When this record was created.
UpdatedAt	Datetime	False		No	When this record last got updated.
Url	String	False		No	The url of this resource.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when the ticket is created.
Name	String	False		No	A unique name for the organization.
GroupId	Long	False	Groups.Id	No	New tickets from users in this organization are automatically put in this group.
ExternalId	String	False		No	A unique external id to associate organizations to an external record.
CreatedAt	Datetime	True		No	The time the organization was created.
UpdatedAt	Datetime	True		No	The time of the last update of the organization.
DomainNames	String	False		No	An array of domain names associated with this organization.
Details	String	False		No	Any details obout the organization, such as the address.
Notes	String	False		No	Any notes you have about the organization.
SharedTickets	Boolean	False		No	End users in this organization are able to see tickets of each other.
SharedComments	Boolean	False		No	End users in this organization are able to see comments on tickets of each other.
Tags	String	False		No	The tags of the organization.
Url	String	True		No	The URL for this resource.
UserId	Long	False		No	The user id used to query organizations.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Organization subscription id.
OrganizationId	Long	False	Organizations.Id	No	.
UserId	Long	False		No	.
CreatedAt	Datetime	True		No	.
Url	String	True		No	The url of this resource.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when the comment is created.
Url	String	True		No	The API url of the comment.
HtmlUrl	String	True		No	The community url of the comment.
Body	String	False		No	The comment made by the author.
AuthorId	Long	True		No	The id of the author of the comment. *Writable on create by Help Center managers.
PostId	Long	True	Posts.Id	No	The id of the post on which the comment was made.
Official	Boolean	False		No	Whether the comment is marked as official.
VoteSum	Integer	True		No	The sum of upvotes (+1) and downvotes (-1), which may be positive or negative.
VoteCount	Integer	True		No	The total number of upvotes and downvotes.
CreatedAt	Datetime	True		No	The time the post was created.
UpdatedAt	Datetime	True		No	The time of the last update of the post.
FilterBy	String	False		No	May be planned, not_planned, completed, answered or none.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when the post is created.
Url	String	True		No	The API url of the post.
HtmlUrl	String	True		No	The community url of the post.
Title	String	False		No	The title of the post.
Details	String	False		No	The details of the post.
AuthorId	Long	True		No	The id of the author of the post. *Writable on create by Help Center managers.
Pinned	Boolean	False		No	When true, pins the post to the top of its topic.
Featured	Boolean	False		No	Whether the post is featured.
Closed	Boolean	False		No	Whether further comments are allowed.
Status	String	False		No	The status of the post.
VoteSum	Integer	True		No	The sum of upvotes (+1) and downvotes (-1), which may be positive or negative.
VoteCount	Integer	True		No	The total number of upvotes and downvotes.
CommentCount	Integer	True		No	The number of comments on the post.
FollowerCount	Integer	True		No	The number of followers of the post.
TopicId	Long	False	Topics.Id	No	The id of the topic that the post belongs to.
CreatedAt	Datetime	True		No	The time the post was created.
UpdatedAt	Datetime	True		No	The time of the last update of the post.
FilterBy	String	False		No	May be planned, not_planned, completed, answered or none.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Automatically assigned when creating requests.
Subject	String	False		No	The value of the subject field for this request if the subject field is visible to end users; a truncated version of the description otherwise.
Description	String	False		No	The first comment on the request.
Status	String	False		No	The state of the request, new, open, pending, hold, solved, closed.
Priority	String	False		No	The priority of the request, low, normal, high, urgent.
Type	String	False		No	The type of the request, question, incident, problem, task.
OrganizationId	Long	False	Organizations.Id	No	The organization of the requester.
RequesterId	Long	False	Users.Id	No	The id of the requester.
AssigneeId	Long	False	Users.Id	No	The id of the assignee if the field is visible to end users.
GroupId	Long	False	Groups.Id	No	The id of the assigned group if the field is visible to end users.
CollaboratorIds	String	False		No	Who are currently CC'ed on the ticket.
ViaChannel	String	False		No	This tells you how the ticket or event was created. Examples: web, mobile, rule, system.
ViaSource	String	False		No	For some channels a source object gives more information about how or why the ticket or event was created.
IsPublic	Boolean	False		No	Is true if any comments are public, false otherwise.
DueAt	Date	False		No	When the task is due (only applies if the request is of type 'task').
CanBeSolvedByMe	Boolean	False		No	If true, end user can mark request as solved.
Solved	Boolean	False		No	Whether or not request is solved (an end user can set this if 'can_be_solved_by_me', above, is true for that user).
TicketFormId	Long	False	TicketForms.Id	No	The numeric id of the ticket form associated with this request if the form is visible to end users - only applicable for enterprise accounts.
Recipient	String	False		No	The original recipient e-mail address of the request.
FollowupSourceId	Integer	False	Tickets.Id	No	The id of the original ticket if this request is a follow-up ticket.
CreatedAt	Datetime	False		No	The time the request was created.
UpdatedAt	Datetime	False		No	The time of the last update of the request.
Url	String	False		No	The API url of this request.
CustomFields	String	False		No	Custom fields for the request.
CustomStatusId	Long	False		No	The custom ticket status id of the ticket.
EmailCcIds	String	False		No	The ids of users who are currently email CCs on the ticket.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id	Long	False	Requests.Id	No	Automatically assigned when creating requests.
CollaboratorId	Long	False	Collaborators.Id	No	The id of users currently CC'ed on the ticket.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Id for the resource collection. Automatically assigned upon creation.
Resources	String	True	No	Array of resource metadata objects.
CreatedAt	Datetime	True	No	When the resource collection was created.
UpdatedAt	Datetime	True	No	Last time the resource collection was updated.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Automatically assigned upon creation.
TicketId	Integer	False	Tickets.Id	No	The id of ticket being rated.
Score	String	False		No	The rating: offered, unoffered, good or bad. When used in a filter it takes one of values: offered, unoffered, received, received_with_comment, received_without_comment, good, good_with_comment, good_without_comment, bad, bad_with_comment, bad_without_comment.
Comment	String	False		No	The comment received with this rating, if available.
Reason	String	False		No	The reason for a bad rating given by the requester in a follow-up question. Satisfaction reasons must be enabled.
AssigneeId	Long	False	Users.Id	No	The id of agent assigned to at the time of rating.
GroupId	Long	False	Groups.Id	No	The id of group assigned to at the time of rating.
RequesterId	Long	False	Users.Id	No	The id of ticket requester submitting the rating.
CreatedAt	Datetime	False		No	The time the satisfaction rating got created.
UpdatedAt	Datetime	False		No	The time the satisfaction rating got updated.
Url	String	False		No	The API url of this rating.
StartTime	Datetime	False		No	Time of the oldest satisfaction rating.
EndTime	Datetime	False		No	Time of the most recent satisfaction rating.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when creating trigger categories.
ReasonCode	Integer	True	No	An account-level code for referencing the reason. Custom reasons are assigned an auto-incrementing integer (non-system reason codes begin at 1000).
Value	String	True	No	Translated value of the reason in the account locale.
RawValue	String	True	No	The dynamic content placeholder, if present, or the current value, if not.
Url	String	True	No	API URL for the resource.
CreatedAt	Datetime	True	No	The time the reason was created.
UpdatedAt	Datetime	True	No	The time the reason was updated.
DeletedAt	Datetime	True	No	The time the reason was deleted.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned upon creation.
Name	String	False	No	Name of the schedule.
TimeZone	String	False	No	Time zone of the schedule.
Intervals	String	False	No	Array of intervals for the schedule.
CreatedAt	Datetime	True	No	Time the schedule was created.
UpdatedAt	Datetime	True	No	Time the schedule was last updated.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when creating subscriptions.
CategoryId	Long	False	No	The id of the category to which this section belongs.
Name	String	False	No	The name of the section.
Description	String	False	No	The description of the section.
Locale	String	False	No	The locale in which the section is displayed.
ParentSectionId	Long	False	No	The id of the section to which this section belongs. Only writable for Guide Enterprise customers.
CreatedAt	Datetime	True	No	The time at which the section was created.
UpdatedAt	Datetime	True	No	The time at which the section was last updated.
Url	String	True	No	The API url of this section.
HtmlUrl	String	True	No	The url of this section in Help Center.
Outdated	Boolean	True	No	Whether the section is out of date.
Position	Integer	False	No	The position of this section in the section list. Used when sorting is set to manual. By default the section is added to the end of the list.
SourceLocale	String	True	No	The source (default) locale of the section.
ThemeTemplate	String	False	No	The theme template name used to display this section in Help Center.
Sorting	String	False	No	The type of sorting.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when a translation is created.
CreatedById	Long	True		No	The id of the user who created the translation.
UpdatedById	Long	True		No	The id of the user who last updated the translation.
SourceId	Long	True		No	The id of the item that has this translation.
Title	String	False		No	The title of the translation.
Body	String	False		No	HTML body of the translation. Empty by default.
Draft	Boolean	False		No	True if the translation is a draft; false otherwise. False by default.
HtmlUrl	String	True		No	The url of the translation in Help Center.
Locale	String	False		No	The locale of the translation.
Outdated	Boolean	False		No	True if the translation is outdated; false otherwise. False by default.
SourceType	String	True		No	The type of the item that has this translation. Can be article, section, or category.
Url	String	True		No	The API url of the translation.
CreatedAt	Datetime	True		No	The time at which the translation was created.
UpdatedAt	Datetime	True		No	The time at which the translation was last updated.
SectionId	Long	False	Sections.Id	No	Id of the associated section.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when the session is created.
UserId	Long	True	Users.Id	No	The id of the user.
AuthenticatedAt	Datetime	True		No	When the session was created.
LastSeenAt	Datetime	True		No	The last approximate time this session was seen. This does not update on every request.
Url	String	True		No	The API URL of this session.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned upon creation.
Name	String	False	No	Name of this sharing agreement.
Type	String	False	No	Can be one of the following: 'inbound', 'outbound'.
Status	String	False	No	Can be one of the following: 'accepted', 'declined', 'pending', 'inactive'.
PartnerName	String	False	No	Can be one of the following: 'jira', null.
RemoteSubdomain	String	False	No	Subdomain of the remote account or null if not associated with an account.
CreatedAt	Datetime	True	No	The time the record was created.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	Automatically assigned when the event is created.
TicketId	Integer	True	Tickets.Id	No	The parent ticket id of the side conversation.
SideConversationId	String	True	SideConversations.Id	No	The id of the side conversation the event belongs to.
ActorEmail	String	True		No	The email address of the participant.
ActorName	String	True		No	The name of the participant.
ActorUserId	Long	True		No	If the participant is an agent, the agent's user id.
ActorSlackWorkspaceId	String	True		No	If the participant is a Slack user or channel, the Slack workspace id.
ActorSlackChannelId	String	True		No	If the participant is a Slack channel, the Slack channel id.
ActorSupportGroupId	String	True		No	If the participant is a Support ticket, the support group id.
ActorSupportAgentId	String	True		No	If the participant is a Support ticket, the support agent id.
ActorMSTeamsChannelId	String	True		No	If the participant is a Microsoft teams channel, the Teams channel id.
Message	String	True		No	Events of type create and reply have a message.
CreatedAt	Datetime	True		No	The time the side conversation event was created.
Type	String	True		No	The type of event.
Updates	String	True		No	Events of type update have fields here.
via	String	True		No	The channel used when creating the event.
Url	String	True		No	The API url of the side conversation.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
SideConversationEventsId	String	True	SideConversationEvents.Id	No	Side Conversation Events Id.
TicketId	Integer	True	Tickets.Id	No	The parent ticket id of the side conversation.
SideConversationId	String	True	SideConversations.Id	No	The id of the side conversation the event belongs to.
Subject	String	True		No	The subject of the message.
PreviewText	String	True		No	A plain text string describing the message.
Body	String	True		No	The plain text version of the body of the message.
HtmlBody	String	True		No	The HTML version of the body of the message.
FromUserId	Long	True		No	If the participant is an agent, the agent's user id.
FromEmail	String	True		No	The name of the participant.
FromName	String	True		No	The email address of the participant.
To	String	True		No	The list of participants the message was sent to.
ExternalIds	String	True		No	A key-value object where all values are strings. Used for metadata.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
SideConversationEventsId	String	True	SideConversationEvents.Id	No	Side Conversation Events Id.
TicketId	Integer	True	Tickets.Id	No	The parent ticket id of the side conversation.
SideConversationId	String	True	SideConversations.Id	No	The id of the side conversation the event belongs to.
UserId	Long	True		No	If the participant is an agent, the agent's user id.
Email	String	True		No	The email address of the participant.
Name	String	True		No	The name of the participant.
SlackWorkspaceId	String	True		No	If the participant is a Slack user or channel, the Slack workspace id.
SlackChannelId	String	True		No	If the participant is a Slack channel, the Slack channel id.
SupportGroupId	String	True		No	If the participant is a Support ticket, the support group id.
SupportAgentId	String	True		No	If the participant is a Support ticket, the support group id.
MSTeamsChannelId	String	True		No	If the participant is a Microsoft teams channel, the Teams channel id.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
SideConversationId	String	True	SideConversations.Id	No	Side Conversation Id.
TicketId	Integer	True	Tickets.Id	No	The parent ticket id of the side conversation.
UserId	Long	True		No	If the participant is an agent, the agent's user id.
Email	String	True		No	The email address of the participant.
Name	String	True		No	The name of the participant.
SlackWorkspaceId	String	True		No	If the participant is a Slack user or channel, the Slack workspace id.
SlackChannelId	String	True		No	If the participant is a Slack channel, the Slack channel id.
SupportGroupId	String	True		No	If the participant is a Support ticket, the support group id.
SupportAgentId	String	True		No	If the participant is a Support ticket, the support group id.
MSTeamsChannelId	String	True		No	If the participant is a Microsoft teams channel, the Teams channel id.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	Automatically assigned when the side conversation is created.
TicketId	Integer	False	Tickets.Id	No	The parent ticket id of the side conversation.
ExternalIds	String	False		No	A key-value store of metadata. All values must be strings.
Subject	String	False		No	The subject of the side conversation.
CreatedAt	Datetime	True		No	The time the side conversation was created.
UpdatedAt	Datetime	True		No	The time the side conversation was created.
MessageAddedAt	Datetime	True		No	The time of the last message on the side conversation.
Participants	String	False		No	An array of participants in the side conversation.
PreviewText	String	False		No	A plain text text describing the side conversation.
State	String	False		No	The state of the side conversation.
StateUpdatedAt	Datetime	True		No	The time of the update of the state of the side conversation.
Url	String	True		No	The API url of the side conversation.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned.
Title	String	False	No	The title of the SLA policy.
Description	String	False	No	The description of the SLA policy.
CreatedAt	Datetime	True	No	When this locale was created.
UpdatedAt	Datetime	True	No	When this locale was last updated.
Position	Integer	True	No	Position of the SLA policy, determines the order they will be matched. If not specified, SLA Policy is added as the last position.
FilterAll	String	False	No	An object that describes the conditions that a ticket must match in order for an SLA policy to be applied to that ticket.
FilterAny	String	False	No	An object that describes the conditions that a ticket must match in order for an SLA policy to be applied to that ticket.
PolicyMetrics	String	False	No	An object that describes the metric targets for each value of the priority field.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
SlaPolicyId	Long	True	No	SlaPolicy id.
Field	String	True	No	The name of a ticket field.
Operator	String	True	No	A comparison operator.
Value	String	True	No	The value of a ticket field.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
SlaPolicyId	Long	True	No	SlaPolicy id.
Field	String	True	No	The name of a ticket field.
Operator	String	True	No	A comparison operator.
Value	String	True	No	The value of a ticket field.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
SlaPolicyId [KEY]	Long	True	No	SlaPolicy id.
BusinessHours	Boolean	True	No	Boolean value that returns whether the metric targets are being measured in business hours or calendar hours.
Metric	String	True	No	The definition of the time that is being measured.
Priority	String	True	No	Priority that a ticket must match.
Target	Integer	True	No	The time within which the end-state for a metric should be met.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when created.
Name	String	False		No	The name for the address.
Email	String	False		No	The email address (not updateable).
CreatedAt	Datetime	True		No	The time the brand was created.
UpdatedAt	Datetime	True		No	The time of the last update of the brand.
Default	Boolean	False		No	Whether the address is the account's default support address.
BrandId	Long	False	Brands.Id	No	The id of the brand.
ForwardingStatus	String	True		No	Possible values: unknown, waiting, verified, or failed.
SpfStatus	String	True		No	Possible values: unknown, verified, failed.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when the ticket is created.
TicketId	Integer	True	Tickets.Id	No	The ticket ID this suspended email is associated with, if available.
MessageId	String	True		No	The ID of the email, if available.
BrandId	Long	True	Brands.Id	No	The id of the brand this ticket is associated with - only applicable for enterprise accounts.
Recipient	String	True		No	The original recipient e-mail address of the ticket.
Subject	String	True		No	The value of the subject field for this ticket.
Content	String	True		No	The content that was flagged.
AuthorId	Long	True		No	The id of author.
AuthorName	String	True		No	The name of author.
AuthorEmail	String	True		No	The email of author.
Cause	String	True		No	Why the ticket was suspended.
CreatedAt	Datetime	True		No	When this record was created.
UpdatedAt	Datetime	True		No	When this record last got updated.
ViaChannel	String	True		No	.
ViaSourceFromId	Long	True		No	.
ViaSourceFromTitle	String	True		No	.
ViaSourceTo	String	True		No	.
ViaSourceRel	String	True		No	.
Url	String	True		No	The API url of this ticket.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	The ID of the target failure.
StatusCode	Integer	True	No	HTTP status code of the target failure.
TargetName	String	True	No	Name of the target failure.
ConsecutiveFailureCount	Integer	True	No	Number of times the target failed consecutively.
CreatedAt	Datetime	True	No	Time of the failure.
RawRequest	String	True	No	The raw message of the target request.
RawResponse	String	True	No	The raw response of the failure.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when Target is created.
Type	String	False	No	A pre-defined target, such as basecamp_target.
Title	String	False	No	A name for the target.
Active	Boolean	False	No	Whether or not the target is activated.
Email	String	False	No	Email.
Subject	String	False	No	Subject of the email.
Url	String	True	No	Url.
CreatedAt	Datetime	True	No	The time the target was created.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Automatically assigned when creating audits.
TicketId	Integer	False	Tickets.Id	No	The ID of the associated ticket.
AuthorId	Long	False	Users.Id	No	The user who created the audit.
CreatedAt	Datetime	False		No	The time the audit was created.
Metadata	String	False		No	Metadata for the audit, custom and system data.
ViaChannel	String	False		No	This object explains how this audit was created. This does not update on every request.
ViaSource	String	False		No	This object explains how this audit was created. This does not update on every request.
Events	String	False		No	The Array of Events that happened in this Audit.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Automatically assigned when the ticket is created.
TicketId	Integer	False	Tickets.Id	No	The id of the ticket the comment belongs to.
AuthorId	Long	False	Users.Id	No	The id of the comment author.
AuditId	Long	False		No	The id of the ticket audit record.
Type	String	False		No	Comment or VoiceComment.
Body	String	False		No	The comment string.
CreatedAt	Datetime	False		No	The time the comment was created.
HtmlBody	String	False		No	The comment formatted as HTML.
PlainBody	String	False		No	The comment as plain text.
IsPublic	Boolean	False		No	True if a public comment; false if an internal note. The initial value set on ticket creation persists for any additional comment unless you change it.
ViaChannel	String	False		No	This tells you how the ticket or event was created. Examples: 'web', 'mobile', 'rule', 'system'.
ViaSource	String	False		No	.
MetadataCustom	String	False		No	.
MetadataSystemClient	String	False		No	.
MetadataSystemIpAddres	String	False		No	.
MetadataSystemLatitude	String	False		No	.
MetadataSystemLongitude	String	False		No	.
MetadataSystemLocation	String	False		No	.
UpdatedAt	Datetime	False		Yes	The time of the comment was updated.
ReferenceNumber	String	False		Yes	Reference number which can be use while doing temp table insertion.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
TicketId	Long	False	Tickets.id	No	The id of the Ticket.
UserId	String	False	Users.id	No	The id of the User.
Name	String	False		No	Name of the User.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Automatically assigned when Ticket Event is created.
TicketId	Integer	False	Tickets.Id	No	The ticket Id.
ChildEvents	String	False		No	Array of the Child Events.
UpdaterId	Long	False		No	Updater Id.
Timestamp	String	False		No	Timestamp at which event is created.
Via	String	False		No	The medium through which event is created.
SystemClient	String	False		No	System client information.
SystemLocation	String	False		No	System location information.
SystemLatitude	String	False		No	System latitude information.
SystemLongitude	String	False		No	System longitude information.
EventType	String	False		No	Type of the Event.
CreatedAt	Datetime	False		No	When this record was created.
Metadata	String	False		No	The metadata of the event.
StartTime	Datetime	False		Yes	The time to start the incremental export from. Must be at least one minute in the past. If not provided, it will take the starttime for the most recent minute.
Include	Boolean	False		Yes	If true, it will include the comments in the event stream. By default, value is false.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when the ticket is created.
Type	String	False	No	The type of the ticket field: checkbox, date, decimal, integer, regexp, tagger, text, or textarea. Type is not editable once created.
Title	String	False	No	The title of the ticket field.
RawTitle	String	False	No	The dynamic content placeholder, if present, or the 'title' value, if not.
Description	String	False	No	The description of the purpose of this ticket field, shown to users.
RawDescription	String	False	No	The dynamic content placeholder, if present, or the 'description' value, if not.
Position	Integer	False	No	A relative position for the ticket fields that determines the order of ticket fields on a ticket. Note that positions 0 to 7 are reserved for system fields.
Active	Boolean	False	No	Whether this field is available.
Required	Boolean	False	No	Whether this field is available.
CollapsedForAgents	Boolean	False	No	If this field should be shown to agents by default or be hidden alongside infrequently used fields. Classic interface only.
RegexpForValidation	String	False	No	Regular expression field only. The validation pattern for a field value to be deemed valid.
TitleInPortal	String	False	No	The title of the ticket field when shown to end users.
RawTitleInPortal	String	False	No	The dynamic content placeholder, if present, or the 'title_in_portal' value, if not.
VisibleInPortal	Boolean	False	No	Whether this field is available to end users.
EditableInPortal	Boolean	False	No	Whether this field is editable by end users.
Tag	String	False	No	A tag value to set for checkbox fields when checked.
CreatedAt	Datetime	True	No	The time the ticket field was created.
UpdatedAt	Datetime	True	No	The time of the last update of the ticket field.
SystemFieldOptions	String	True	No	Presented for a ticket field of type 'tickettype', 'priority' or 'status'.
CustomFieldOptions	String	False	No	Required and presented for a ticket field of type 'tagger'.
Removable	Boolean	True	No	If this field is not a system basic field that must be present for all tickets on the account.
Url	String	True	No	The URL for this resource.
AgentDescription	String	False	No	A description of the ticket field that only agents can see.
CustomStatuses	String	True	No	List of customized ticket statuses. Only presented for a system ticket field of type custom_status.
RelationshipFilterAll	String	False	No	A filter definition that allows your autocomplete to filter down results with Logical AND.
RelationshipFilterAny	String	False	No	A filter definition that allows your autocomplete to filter down results with Logical OR.
RelationshipTargetType	String	False	No	A representation of what type of object the field references. Options are zen, zen, zen, or zen:custom_object. For example zen:custom_object.
RequiredInPortal	String	False	No	If true, end users must enter a value in the field to create the request.
SubTypeId	String	False	No	For system ticket fields of type priority and status. Defaults to 0. A priority sub type of 1 removes the Low and Urgent options. A status sub type of 1 adds the On-Hold option.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
TicketFieldId	Long	True	TicketFields.Id	No	The Ticket field id.
Field	String	True		No	The name of a ticket field.
Operator	String	True		No	A comparison operator.
Value	String	True		No	The value of a ticket field.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
TicketFieldId	Long	True	TicketFields.Id	No	The Ticket field id.
Field	String	True		No	The name of a ticket field.
Operator	String	True		No	A comparison operator.
Value	String	True		No	The value of a ticket field.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Ticket form id.
Name	String	False	No	The name of the form.
RawName	String	False	No	The dynamic content placeholder, if present, or the 'name' value, if not.
DisplayName	String	False	No	The name of the form that is displayed to an end user.
RawDisplayName	String	False	No	The dynamic content placeholder, if present, or the 'display_name' value, if not.
Position	Integer	False	No	The position of this form among other forms in the account, i.e. dropdown.
Active	Boolean	False	No	If the form is set as active.
EndUserVisible	Boolean	False	No	Is the form visible to the end user.
Default	Boolean	False	No	Is the form the default form for this account.
TicketFieldIds	String	False	No	Ids of all ticket fields which are in this ticket form.
InAllBrands	Boolean	False	No	Is the form available for use in all brands on this account.
RestrictedBrandIds	String	False	No	Ids of all brands that this ticket form is restricted to.
FallbackToDefault	Boolean	False	No	If true, returns default ticket form when the criteria defined by the parameters results in a set without active and end user visible ticket forms.
AssociatedToBrand	Boolean	False	No	Only ticket forms of current brand (defined by url) if true.
CreatedAt	Datetime	True	No	The time the ticket form was created.
UpdatedAt	Datetime	True	No	The time of the last update of the ticket form.
AgentConditions	String	False	No	Array of condition sets for agent workspaces.
EndUserConditions	String	False	No	Array of condition sets for end user products.
Url	String	True	No	URL of the ticket form.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Automatically assigned when the record is created.
TicketId	Integer	False	Tickets.Id	No	The Id of the associated ticket.
Metric	String	False		No	One of the following: agent_work_time, pausable_update_time, periodic_update_time, reply_time, requester_wait_time, or resolution_time.
InstanceId	Long	False		No	The instance of the metric associated with the event.
Type	String	False		No	When this locale last got updated.
Time	Datetime	False		No	The time the event occurred.
Sla	String	False		No	Available if type is apply_sla. The SLA policy and target being enforced on the ticket and the metric in question, if any.
Status	String	False		No	Available if type is update_status. Minutes since the metric has been open. See status.
Deleted	Boolean	False		No	Available if type is breach. In general, you can ignore any breach event when deleted is true.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	False		No	Automatically assigned.
TicketId [KEY]	Integer	False	Tickets.Id	No	The ID of the associated ticket.
GroupStations	Integer	False		No	Number of groups this ticket passed through.
AssigneeStations	Integer	False		No	Number of assignees this ticket had.
Reopens	Integer	False		No	Total number of times the ticket was reopened.
Replies	Integer	False		No	Total number of times ticket was replied to.
AssigneeUpdatedAt	Datetime	False		No	When the assignee last updated the ticket.
RequesterUpdatedAt	Datetime	False		No	When the requester last updated the ticket.
StatusUpdatedAt	Datetime	False		No	When the status was last updated.
InitiallyAssignedAt	Datetime	False		No	When the ticket was initially assigned.
AssignedAt	Datetime	False		No	When the ticket was last assigned.
SolvedAt	Datetime	False		No	When the ticket was solved.
LatestCommentAddedAt	Datetime	False		No	When the latest comment was added.
FirstResolutionTimeCalendar	Int	False		No	Number of minutes to the first resolution time inside and out of business hours.
FirstResolutionTimeBusiness	Int	False		No	Number of minutes to the first resolution time inside and out of business hours.
ReplyTimeCalendar	Int	False		No	Number of minutes to the first reply inside and out of business hours.
ReplyTimeBusiness	Int	False		No	Number of minutes to the first reply inside and out of business hours.
FullResolutionTimeCalendar	Int	False		No	Number of minutes to the full resolution inside and out of business hours.
FullResolutionTimeBusiness	Int	False		No	Number of minutes to the full resolution inside and out of business hours.
AgentWaitTimeCalendar	Int	False		No	Number of minutes the agent spent waiting inside and out of business hours.
AgentWaitTimeBusiness	Int	False		No	Number of minutes the agent spent waiting inside and out of business hours.
RequesterWaitTimeCalendar	Int	False		No	Number of minutes the requester spent waiting inside and out of business hours.
RequesterWaitTimeBusiness	Int	False		No	Number of minutes the requester spent waiting inside and out of business hours.
CreatedAt	Datetime	False		No	When this record was created.
UpdatedAt	Datetime	False		No	When this record last got updated.
Url	String	False		No	The API url of this ticket metric.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
TicketId	Long	False	Tickets.id	No	The id of the Ticket.
TopicId	String	False		No	Related topic in the Web portal (deprecated feature).
JiraIssueIds	String	False		No	Jira issues Id.
FollowupSourceIds	String	False		No	Sources to follow up.
FromArchive	Boolean	False		No	Is true if the current ticket is archived.
Incidents	Integer	False		No	A count of related incident occurrences.
Url	String	False		No	Url.
Twitter	String	False		No	X (formerly Twitter) information associated with the ticket.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False		No	Automatically assigned when the ticket is created.
Subject	String	False		No	The value of the subject field for this ticket. When used in WHERE clause: The text in the ticket's subject.
RawSubject	String	False		No	The dynamic content placeholder, if present, or the subject value, if not.
Description	String	False		No	The first comment on the ticket. When used in WHERE clause: The text in the ticket's description and comments.
Type	String	False		No	The type of this ticket. Possible values: problem, incident, question or task.
Priority	String	False		No	The urgency with which the ticket should be addressed. Possible values: urgent, high, normal, low.
Status	String	False		No	The state of the ticket. Possible values: new, open, pending, hold, solved, closed.
Recipient	String	False		No	The original recipient e-mail address of the ticket.
HasIncidents	Boolean	False		No	Is true of this ticket has been marked as a problem, false otherwise.
DueAt	Datetime	False		No	If this is a ticket of type task it has a due date. Due date format uses ISO 8601 format.
RequesterId	Long	False	Users.Id	No	The user who requested this ticket.
SubmitterId	Long	False	Users.Id	No	The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket.
AssigneeId	Long	False	Users.Id	No	The agent currently assigned to the ticket.
OrganizationId	String	False	Organizations.Id	No	The organization of the requester. You can only specify the ID of an organization associated with the requester.
GroupId	Long	False	Groups.Id	No	The ID of the group, to which the Ticket is assigned.
CollaboratorIds	String	False		No	The ids of users currently cc-ed on the ticket.
FollowerIds	String	False		No	Agents currently following the ticket.
ForumTopicId	Long	False	Topics.Id	No	The topic this ticket originated from, if any.
ProblemId	Integer	False	Tickets.Id	No	For tickets of type incident, the ID of the problem the incident is linked to.
ExternalId	String	False		No	An id you can use to link Zendesk Support tickets to local records.
FollowupIds	String	False		No	Closed tickets only. The ids of the followups created from this ticket.
MacroIds	String	False		No	POST requests only. List of macro IDs to be recorded in the ticket audit.
TicketFormId	Long	False	TicketForms.Id	No	Enterprise only. The id of the ticket form to render for the ticket.
BrandId	Long	False	Brands.Id	No	Enterprise only. The id of the brand this ticket is associated with.
Tags	String	False		No	The array of tags applied to this ticket.
ViaChannel	String	False		No	This tells you how the ticket or event was created. Examples: web, mobile, rule, system.
ViaSource	String	False		No	The ticket's source.
SatisfactionRating	String	False		No	The satisfaction rating of the ticket, if it exists, or the state of satisfaction, 'offered' or 'unoffered'.
SharingAgreementIds	String	False		No	The ids of the sharing agreements used for this ticket.
AllowChannelback	Boolean	False		No	Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket.
IsPublic	Boolean	False		No	Is true if any comments are public, false otherwise.
CreatedAt	Datetime	False		No	When this record was created.
UpdatedAt	Datetime	False		No	When this record last got updated.
Url	String	False		No	The API url of this ticket.
View_Id	Long	False	Views.Id	No	The view that tickets belong to.
User_Id	Long	False	Users.Id	No	The user that tickets belong to.
Assignee	String	False		No	The assigned agent or other entity. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number.
GroupName	String	False		No	The name of the group to which the Ticket is assigned. If it is not used as a query filter, a search on this column results in null.
Requester	String	False		No	The ticket requester. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number.
Submitter	String	False		No	The ticket submitter. This may be different than the requester if the ticket was submitted by an agent on behalf of the requester. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number. .
Brand	String	False		No	Search for a specific Brand on a ticket. If it is not used as a query filter, a search on this column results in null.
Commenter	String	False		No	People who have added comments to tickets. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number.
Cc	String	False		No	People who have been CC'd on tickets. You can specify 'none', 'me', user name (full name or partial), email address, user ID, or phone number.
HasAttachment	Boolean	False		No	Search for all tickets with or without attachments using 'true' or 'false'.
AllowAttachments	Boolean	False		No	Permission for agents to add add attachments to a comment. Defaults to true.
CustomStatusId	Long	False		No	The custom ticket status id of the ticket.
EmailCcIds	String	False		No	An array of objects that represent agent or end users email CCs to add or delete from the ticket.
FromMessagingChannel	Boolean	False		No	If true, the ticket's via type is a messaging channel.
ResultType	String	False		No	Result type.
Via	String	False		Yes	The ticket's source, which can be any of the following, api, phone, etc.
ViaFollowupSourceId	String	False		Yes	POST requests only. The id of a closed ticket when creating a follow-up ticket.
Solved	Date	False		Yes	The date the ticket was set to solved.
Comment	String	False		Yes	Used to create a comment on the ticket, when creating or updating a ticket.
IsPublicComment	Boolean	False		Yes	Used when creating a comment on the ticket. Set this to true to add a public comment and false to add an internal note.
TicketComments	String	False		Yes	Ticket comments object.
ReferenceNumber	String	False		Yes	Reference number which can be use while doing temp table insertion.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned upon creation.
TicketId	Integer	False	Tickets.Id	No	ID of the skipped ticket.
UserId	Long	True	Users.Id	No	ID of the skipping agent.
Ticket	String	True		No	The skipped ticket object.
Reason	String	False		No	Reason for skipping the ticket.
CreatedAt	Datetime	True		No	Time the skip was created.
UpdatedAt	Datetime	True		No	Time the skip was last updated.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False	Tickets.Id	No	Automatically assigned when the ticket is created.
CollaboratorId [KEY]	Long	False	Collaborators.Id	No	The ids of users currently cc-ed on the ticket.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False	Tickets.Id	No	Automatically assigned when the ticket is created.
FollowerId [KEY]	Long	False	Users.Id	No	Agents currently following the ticket.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False	Tickets.Id	No	Automatically assigned when the ticket is created.
FollowupId [KEY]	Integer	False	Tickets.Id	No	Closed tickets only. The ids of the followups created from this ticket.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False	Tickets.Id	No	Automatically assigned when the ticket is created.
MacroId [KEY]	Long	False	Macros.Id	No	POST requests only. List of macro IDs to be recorded in the ticket audit.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False	Tickets.Id	No	Automatically assigned when the ticket is created.
SatisfactionRatingComment	String	False		No	Comment of satisfaction rating for the ticket.
SatisfactionRatingId	Long	False	SatisfactionRatings.Id	No	Id of satisfaction rating for the ticket.
SatisfactionRatingScore	String	False		No	Score of satisfaction rating for the ticket.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False	Tickets.Id	No	Automatically assigned when the ticket is created.
SharingAgreementId [KEY]	Long	False	SharingAgreements.Id	No	The ids of the sharing agreements used for this ticket.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False	Tickets.Id	No	Automatically assigned when the ticket is created.
Tag [KEY]	String	False		No	The array of tags applied to this ticket.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Integer	False	Tickets.Id	No	Automatically assigned when the ticket is created.
ViaSourceFrom	String	False		No	The ticket's source via from.
ViaSourceRel [KEY]	String	False		No	The ticket's source via relation.
ViaSourceTo	String	False		No	The ticket's source via to.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	False	No	Automatically assigned when the topic is created.
Url	String	False	No	The API url of the topic.
HtmlUrl	String	False	No	The community url of the topic.
Name	String	False	No	The name of the topic.
Description	String	False	No	The description of the topic. By default an empty string.
Position	Integer	False	No	The position of the topic relative to other topics in the community.
FollowerCount	Integer	False	No	The number of users following the topic.
ManageableBy	String	False	No	The set of users who can manage this topic.
UserSegmentId	Long	False	No	The id of the user segment to which this topic belongs.
CreatedAt	Datetime	False	No	When the topic was created.
UpdatedAt	Datetime	False	No	When the topic was last updated.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when a translation is created.
CreatedById	Long	True	No	The id of the user who created the translation.
UpdatedById	Long	True	No	The id of the user who last updated the translation.
SourceId	Long	True	No	The id of the item that has this translation.
Title	String	False	No	The title of the translation.
Body	String	False	No	HTML body of the translation. Empty by default.
Draft	Boolean	False	No	True if the translation is a draft; false otherwise. False by default.
HtmlUrl	String	True	No	The url of the translation in Help Center.
Locale	String	False	No	The locale of the translation.
Outdated	Boolean	False	No	True if the translation is outdated; false otherwise. False by default.
SourceType	String	True	No	The type of the item that has this translation. Can be article, section, or category.
Url	String	True	No	The API url of the translation.
CreatedAt	Datetime	True	No	The time at which the translation was created.
UpdatedAt	Datetime	True	No	The time at which the translation was last updated.
ArticleId	Long	False	Yes	Id of the associated article.
SectionId	Long	False	Yes	Id of the associated section.
CategoryId	Long	False	Yes	Id of the associated category.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	Automatically assigned when creating trigger categories.
Name	String	False	No	The name of the trigger category.
Position	Integer	False	No	The position of the trigger category.
CreatedAt	Datetime	True	No	The time at which the trigger category was created.
UpdatedAt	Datetime	True	No	The time at which the trigger category was last updated.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when created.
Title	String	False	No	The title of the trigger.
Active	Boolean	False	No	Whether the trigger is active.
Position	Integer	False	No	Position of the trigger, determines the order they will execute in.
ConditionsAll	String	False	No	An object that describes the conditions under which the trigger will execute.
ConditionsAny	String	False	No	An object that describes the conditions under which the trigger will execute.
Actions	String	False	No	An object describing what the trigger will do.
Description	String	False	No	The description of the trigger.
CreatedAt	Datetime	True	No	The time the trigger was created.
UpdatedAt	Datetime	True	No	The time of the last update of the trigger.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	False		No	ID of the event.
UserId	Long	False	Users.id	No	The id of the User.
Type	String	False		No	Event name.
Source	String	False		No	Application which sent the event.
Description	String	False		No	An event description.
CreatedAt	Datetime	False		No	ISO-8601 compliant date-time reflecting the time the event was created. If not set, the API sets the value when it receives the event.
ReceivedAt	Datetime	False		No	ISO-8601 compliant date-time reflecting the time the event was received.
Properties	String	False		No	A custom JSON object with details about the event. Must comply with the JSON Schema specification.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned upon creation.
Key	String	False	No	A unique key that identifies this custom field. Required on create.This is used for updating the field and referencing in placeholders.After a field is created, you cannot change its key.
Type	String	False	No	Type of the custom field: checkbox, date, decimal, dropdown, integer, regexp, text, or textarea. After a field is created, you cannot change its type.
Title	String	False	No	The title of the custom field.
RawTitle	String	False	No	The dynamic content placeholder, if present, or the title value, if not.
Description	String	False	No	User-defined description of this field's purpose.
RawDescription	String	False	No	The dynamic content placeholder, if present, or the description value, if not.
Position	Integer	False	No	Ordering of the field relative to other fields.
Active	Boolean	False	No	If true, this field is available for use.
System	Boolean	True	No	If true, only active and position values of this field can be changed.
RegexpForValidation	String	False	No	Regular expression field only. The validation pattern for a field value to be deemed valid.
CreatedAt	Datetime	True	No	The time the ticket field was created.
UpdatedAt	Datetime	True	No	The time of the last update of the ticket field.
Tag	String	False	No	Optional for custom field of type checkbox; not presented otherwise.
CustomFieldOptions	String	False	No	Required and presented for a custom field of type dropdown.
Url	String	True	No	The URL for this resource.
RelationshipTargetType	String	False	No	A representation of what type of object the field references. Options are zen, zen, zen, and zen:custom_object. For example: zen:custom_object.
RelationshipFilterAll	String	False	No	A filter definition that allows your autocomplete to filter down results with Logical AND.
RelationshipFilterAny	String	False	No	A filter definition that allows your autocomplete to filter down results with Logical OR.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
UserFieldId	Long	True	UserFields.Id	No	The User field id.
Field	String	True		No	The name of a ticket field.
Operator	String	True		No	A comparison operator.
Value	String	True		No	The value of a ticket field.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
UserFieldId	Long	True	UserFields.Id	No	The User field id.
Field	String	True		No	The name of a ticket field.
Operator	String	True		No	A comparison operator.
Value	String	True		No	The value of a ticket field.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned on creation.
UserId [KEY]	Long	False	Users.Id	No	The id of the user.
Type	String	False		No	One of email, twitter, facebook, google, or phone_number.
Value	String	False		No	The identifier for this identity, such as an email address.
Verified	Boolean	False		No	If the identity has been verified.
Primary	Boolean	True		No	If the identity is the primary identity. Writable only when creating, not when updating.
CreatedAt	Datetime	True		No	The time the ticket field was created.
UpdatedAt	Datetime	True		No	The time of the last update of the ticket field.
UndeliverableCount	Integer	True		No	The time of the last update of the ticket field.
DeliverableState	String	True		No	The time of the last update of the ticket field.
Url	String	True		No	The URL for this resource.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
UserId	Long	False	Users.id	No	The id of the user.
AssignedTickets	Integer	False		No	Count of assigned tickets.
RequestedTickets	Integer	False		No	Count of requested tickets.
CcdTickets	Integer	False		No	Count of collaborated tickets.
OrganizationSubscriptions	Integer	False		No	Count of organization subscriptions.
Topics	Integer	False		No	Count of topics (Web portal only).
TopicComments	Integer	False		No	Count of comments on topics (Web portal only).
Votes	Integer	False		No	Count of votes (Web portal only).
Subscriptions	Integer	False		No	Count of subscriptions (Web portal only).
EntrySubscriptions	Integer	False		No	Count of entry subscriptions (Web portal only).
ForumSubscriptions	Integer	False		No	Count of forum subscriptions (Web portal only).

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when the ticket is created.
Email	String	False		No	The primary email address of the user. Writeable on create only. On update, a secondary email is added.
Name	String	False		No	The name of the user.
Role	String	False		No	The role of the user. Possible values are end-user, agent, or admin.
Active	Boolean	True		No	False if the user has been deleted.
OrganizationId	Long	False	Organizations.Id	No	The id of the organization the user is associated with.
Alias	String	False		No	An alias displayed to end users.
Verified	Boolean	False		No	If the identity of the user has been verified or not.
ChatOnly	Boolean	True		No	Whether or not the user is a chat-only agent.
CreatedAt	Datetime	True		No	The time the user was created.
UpdatedAt	Datetime	True		No	The time the user was last updated.
CustomRoleId	Long	False		No	A custom role if the user is an agent on the Enterprise plan.
RoleType	String	True		No	The role id of the user. 0 for custom agents, 1 for light agent and 2 for chat agent.
DefaultGroupId	Long	False		No	The id of the default group of the user. Can only be set on create, not on update.
Details	String	False		No	Any details you want to store about the user, such as an address.
ExternalId	String	False		No	A unique identifier from another system.
LastLoginAt	Datetime	True		No	The last time the user signed in to Zendesk Support.
Locale	String	True		No	The locale of the user.
LocaleId	Long	False		No	The language identifier of the user.
Moderator	Boolean	False		No	Designates whether the user has forum moderation capabilities.
Notes	String	False		No	Any notes you want to store about the user.
OnlyPrivateComments	Boolean	False		No	True if the user can only create private comments.
Phone	String	False		No	The primary phone number of the user.
Photo	String	True		No	photo attachment.
PhotoThumbnails	String	True		No	photo thumbnails.
PhotoInline	Boolean	True		No	If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false.
RestrictedAgent	Boolean	False		No	If the agent has any restrictions; false for admins and unrestricted agents, true for other agents.
Shared	Boolean	True		No	If the user is shared from a different Zendesk Support instance. Ticket sharing accounts only.
SharedAgent	Boolean	True		No	If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only.
Signature	String	False		No	The signature of the user. Only agents and admins can have signatures.
Suspended	Boolean	False		No	If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal.
Tags	String	False		No	The tags of the user. Only present if your account has user tagging enabled.
TicketRestriction	String	False		No	Specifies which tickets the user has access to. Possible values are: organization, groups, assigned, requested, null.
TimeZone	String	False		No	The time zone of the user.
TwoFactorAuthEnabled	Boolean	True		No	If two factor authentication is enabled.
Url	String	False		No	The API url of the user.
GroupName	String	False		No
Organization	String	False		No	The name of the organization the user is associated with.
GroupId	String	False		No	The name of the group the user belongs to.
PermissionSet	String	False		No	Used for custom roles in the Enterprise plan. You can only filter by one role id per request.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	Long	True	No	Automatically assigned when the user segment is created.
BuiltIn	Boolean	True	No	Whether the user segment is built-in. Built-in user segments cannot be modified.
Name	String	False	No	User segment name (localized to the locale of the current user for built-in user segments).
OrTags	String	False	No	A user must have at least one tag in the list to have access. For insertion and updation provide these values separated by semicolon.
GroupIds	String	False	No	The ids of the groups that have access. For insertion and updation provide these values separated by semicolon.
OrganizationIds	String	False	No	The ids of the organizations that have access. For insertion and updation provide these values separated by semicolon.
Tags	String	False	No	All the tags a user must have to have access. For insertion and updation provide these values separated by semicolon.
UserType	String	False	No	The set of users who can view content. The UserType can be 'signed_in_users' for only authenticated users and 'staff' for only agents and Help Center managers.
CreatedAt	Datetime	True	No	When the user segment was created.
UpdatedAt	Datetime	True	No	When the user segment was last updated.
UserId	Long	False	Yes	Id of the User.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when the subscription is created.
UserId	Long	True	Users.Id	No	The Id of the User.
FollowedId	Long	True		No	The id of the user being followed.
FollowerId	Long	True		No	The id of the user doing the following.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when the ticket is created.
Title	String	False		No	The title of the view.
Active	Boolean	False		No	Useful for determining if the view should be displayed.
SlaId	Long	False	SlaPolicies.Id	No	If the view is for an SLA, shows the id.
RestrictionId	Long	True		No	The id of the restricion (who may access this account. Will be null when everyone in the account can access it).
RestrictionType	String	False		No	The type of the restricion (who may access this account. Will be null when everyone in the account can access it).
RestrictionIds	String	False		No	The numeric IDs of a single or more groups. Recommended for 'Group' type.
Position	Integer	False		No	The position of the view.
ExecutionGroupBy	String	False		No	Group the tickets by a column in the View columns table. The subject and submitter columns are not supported.
ExecutionGroupOrder	String	False		No	Group the tickets by a column in the View columns table either by specifying asc or desc.
ExecutionSortBy	String	False		No	Sort the tickets by a column in the View columns table. The subject and submitter columns are not supported.
ExecutionSortOrder	String	False		No	Sort the tickets by a column in the View columns table either by specifying asc or desc.
ExecutionGroup	String	False		No	When present, the structure indicating how the tickets are grouped.
ExecutionSort	String	False		No	The column structure of the field used for sorting.
ExecutionColumns	String	False		No	The ticket fields to display. For Insert, give the list of value separated by semi-colon.
ExecutionFields	String	False		No	Execution is an object describing how the view should be executed.
ExecutionCustomFields	String	False		No	Execution is an object describing how the view should be executed.
ConditionsAll	String	False		No	Logical AND. Tickets must fulfill all of the conditions to be considered matching.Conditions is an object describing how the view is constructed.
ConditionsAny	String	False		No	Logical OR. Tickets may satisfy any of the conditions to be considered matching.Conditions is an object describing how the view is constructed.
CreatedAt	Datetime	True		No	The time the view was created.
UpdatedAt	Datetime	True		No	The time of the last update of the view.
Access	String	False		No	Only views with given access. May be personal, shared, or account.
GroupId	Long	False	Groups.Id	No	The group id the view belongs to. Used to query the table.
Default	Boolean	False		No	If true, the view is a default view.
Description	String	False		No	The description of the view.
RawTitle	String	False		No	The raw title of the view.
Url	String	True		No	Url.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
ViewId [KEY]	Long	True	No	View id.
Active	Boolean	True	No	Useful for determining if the view should be displayed.
Access	String	True	No	Only views with given access. May be personal, shared, or account.
GroupId	Long	True	No	The group id the view belongs to. Used to query the table.
Field	String	True	No	The name of a ticket field.
Operator	String	True	No	A comparison operator.
Value	String	True	No	The value of a ticket field.

Return to Top

Name	Type	ReadOnly	FilterOnly	Description
ViewId [KEY]	Long	True	No	View id.
Active	Boolean	True	No	Useful for determining if the view should be displayed.
Access	String	True	No	Only views with given access. May be personal, shared, or account.
GroupId	Long	True	No	The group id the view belongs to. Used to query the table.
Field	String	True	No	The name of a ticket field.
Operator	String	True	No	A comparison operator.
Value	String	True	No	The value of a ticket field.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	Long	True		No	Automatically assigned when the vote is created.
UserId	Long	True	Users.Id	No	The id of the user who cast this vote.
ItemId	Long	True		No	The id of the item for which this vote was cast.
ItemType	String	True		No	The type of the item. Can be Article, Comment, Post or PostComment.
Value	Integer	False		No	The value of the vote. Specify 1 for up and -1 for down.
Url	String	True		No	The ids of user segments that have edit privileges. For insertion and updation provide these values separated by semicolon.
CreatedAt	Datetime	True		No	The time at which the vote was created.
UpdatedAt	Datetime	True		No	The time at which the vote was last updated.
Locale	String	False		Yes	The locale value.
ArticleId	Long	False		Yes	The Id of the Article.
CommentId	Long	False		Yes	The Id of the Article Comment or Post Comment.
PostId	Long	False		Yes	The Id of the Post.

Return to Top