Authorizations
- Authorization string required header
All requests require a Bearer token in the
Authorizationheader. API keys are prefixed withfdsk_and should be kept secret. You can generate and manage keys from the Developer settings page.Keys can be restricted to any subset of these scopes (each endpoint lists the scope it requires via
x-required-scopes):content:read: Read and search help center articles, collections, sections, and translationscontent:write: Create and edit article drafts, users, tasks; move articles and collectionscontent:publish: Publish, unpublish, restore, and trash content (make changes live)analytics:read: Read help center reporting, analytics, and article feedbackconversations:read: Read AI assistant conversations and transcriptswebhooks:manage: Create and manage outbound webhook subscriptions
Granting
content:writeorcontent:publishimpliescontent:read. Keys minted before scoping have null scopes = full access (legacy mode).
Query Parameters
- article_id string
Filter by article.
- page_size integer
Number of items to return per page (1-100). Example: 20
- resolved string enum
Filter by resolved state.
- start_cursor string
Opaque pagination cursor. Pass the
next_cursorfrom a previous response to fetch the next page. Example: eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ - type string enum
Filter by feedback type.
Response
application/json- results[] object array
Items in this page. Article feedback entry.
+ - Show Child Attributes
- id string
- articleId string | null
- articleTitle string | null
- type string enum enum
Allowed values: positive, negative.
- feedback string
- email string | null
- resolved boolean
- createdAt string
ISO 8601 timestamp in UTC.
- user anyOf
The help center user auto-matched from the submitter email (unique on email + helpdesk), or null when the submitter is anonymous or unrecognized.
+ - Show Child Attributes
- anyOf options 2 variants anyOf
One or more options can apply.
+ - Show Child Attributes
- option 1 object
+ - Show Child Attributes
- id string
Ferndesk help center user ID (
hcusr_...). - name string | null
Help center user display name.
- email string (email)
Help center user email address. Emails are stored lowercase.
- option 2 null
- has_more boolean
Whether more items are available after this page.
- next_cursor string | null
Cursor to pass as
start_cursorfor the next page, or null on the last page.