Meta tags:
description= Developer documentation for products at Zendesk;
Headings (most frequently used words):
help, center, on, this, page, api, federated, search, employee, services, templates, run, in, postman, download, openapi, file, data, types, pagination, rate, limits,
Text of the page (most frequently used words):
the (44), api (29), page (26), help (21), #center (21), pagination (16), for (15), zendesk (11), and (11), introduction (9), you (9), user (9), requests (8), request (8), this (7), postman (7), community (6), limits (6), offset (6), can (6), types (6), content (6), comments (6), see (5), general (5), rate (5), list (5), using (5), example (5), data (5), download (5), articles (5), article (5), templating (5), per (4), with (4), cursor (4), information (4), only (4), openapi (4), file (4), made (4), templates (4), post (4), search (4), developer (3), available (3), works (3), 100 (3), most (3), records (3), endpoint (3), more (3), apis (3), are (3), following (3), use (3), brand (3), that (3), returns (3), rest (3), upgrading (3), from (3), external (3), don (2), limit (2), described (2), number (2), when (2), parameter (2), string (2), per_page (2), based (2), method (2), endpoints (2), size (2), supports (2), results (2), specific (2), account (2), app (2), about (2), have (2), brand1 (2), items (2), all (2), section (2), reference (2), documentation (2), custom (2), topic (2), new (2), service (2), catalog (2), home (2), objects (2), helpers (2), badge (2), categories (2), subscriptions (2), zendev_horizontal (2), system, status, terms, privacy, notice, 181, fremont, street, 17th, floor, san, francisco, california, 94105, slack, blog, forum, join, our, follows, support, minute, one, count, against, other, backward, compatibility, pages, may, further, future, return, default, change, basis, including, query, however, exceed, preferred, activate, adding, two, methods, paginating, through, specified, used, locales, returned, passed, strings, recommends, type, ids, sign, free, exploring, website, import, collection, into, your, then, try, out, different, learn, how, click, button, get, started, run, multiple, brands, must, subdomain, named, might, look, like, https, com, help_center, both, but, provides, access, means, actually, responses, always, filtered, according, permissions, whose, behalf, view, any, mechanisms, conventions, such, authentication, work, considered, implied, text, concerns, profile, error, approval, contributions, category, footer, header, advanced, employee, services, sources, federated, redirect, rules, claims, jwts, tags, guide, media, images, assignments, badges, votes, segments, posts, topics, themes, translations, management, permission, groups, sessions, sections, labels, attachments, docs,
Text of the page (random words):
help center zendesk developer docs zendev_horizontal zendev_horizontal documentation api reference search help center home help center help center help center api articles article attachments article comments article labels categories search sections sessions management permission groups translations themes topics posts post comments content subscriptions user subscriptions user segments votes badges badge assignments badge categories user images guide media objects content tags help center jwts account custom claims redirect rules federated search introduction external content records external content sources external content types employee services service catalog items help center templates introduction helpers advanced helpers objects header footer home page category page section page article page contributions page following page request list page request page new request page search results page service catalog page templates approval request page templates error page new community post page community post page community post list page community topic page community topic list page user profile page custom page upgrading from templating api v1 upgrading from templating api v2 upgrading from templating api v3 on this page download openapi file data types pagination rate limits help center on this page download openapi file data types pagination rate limits this is the reference documentation for the zendesk help center rest api and the help center templating api for an introduction to the templating api see help center templates the rest of this introduction concerns the rest api any general mechanisms and conventions such as pagination and authentication work as described in the zendesk api introduction and are considered implied in this text responses are always filtered according to the permissions of the user on whose behalf the api request is made for example when the user requests a list of articles in a section the api returns only the articles the user can view in the help center the api works only with help center items for example comments can be made on both articles and requests but the help center api only provides access to article comments this means that an endpoint that returns all comments made by a user actually returns all comments made on help center articles by a user if you have multiple brands you must use the brand specific subdomain in the api requests for example if you have a brand named brand1 a request for information about that brand s help center content might look like https brand1 zendesk com api v2 help_center run in postman if you use postman you can import the help center api endpoints as a collection into your postman app then try out different requests to learn how the api works click the following button to get started if you don t use postman you can sign up for a free account on the postman website and download the app for more information about using postman with zendesk apis see exploring zendesk apis with postman download openapi file download openapi file data types the following is specific to the zendesk help center api zendesk recommends using the string type for ids in help center locales are returned and passed as strings example en us for more information on data types used in the apis see data types in the general api introduction pagination the help center api supports two methods of paginating through results cursor pagination and offset pagination if no pagination method is specified for an endpoint it only supports offset pagination cursor based pagination is the preferred method of pagination and is available for most endpoints activate cursor pagination by adding the page size parameter e g page size 30 to the api endpoint for more information see using cursor based pagination in the general api introduction offset pagination is available for backward compatibility and works as described in using offset pagination in the general api introduction zendesk limits the number of pages available with offset pagination to 100 and may further limit this in the future most list requests return 30 records per page by default when using offset pagination you can change the number on a per request basis by including a per_page parameter in the request s query string example per_page 100 however you can t exceed 100 records per page for most requests rate limits the help center api follows the support api s requests per minute limits see rate limits in the general api introduction requests in one api don t count against the rate limit of the other api join our developer community forum blog slack zendesk 181 fremont street 17th floor san francisco california 94105 privacy notice zendesk developer terms system status
|