API documentation — Helpjuice

Cited by

Facts read from this source

• API rest json Report an error

  “Version 3 of the Helpjuice API is structured around REST, HTTP, and JSON.”

• API base URL Report an error

  “Knowledge Base https://<your-account>.helpjuice.com/api/v3/<resource>”

• API authentication Report an error

  “All requests to the API are authenticated by providing your API key. The API key should be provided as an HTTP header named Authorization or as api_key query parameter.”

• API token requirement option Report an error

  “Require token for API? option in your API Credentials settings page needs to be enabled.”

• API user impersonation Report an error

  “if you would like to "impersonate" a custom user to restrict content and features the user can use, you can do so by using HTTP Basic Auth. Just provide the user's email as the username and a blank password”

• API pagination Report an error

  “Limit The number of results to display in each page ( default = 25, max = 1000 ).”

• API error codes Report an error

  “403 In case the API key is not provided. 404 In case the requested data does not exist. 422 The request could not be processed, usually due to a missing or invalid parameter.”

• API users endpoints Report an error

  “Users Create a New user Update a user Retrieve a user Retrieve all users Delete a user Deactivate a user Activate a user”

• API groups endpoints Report an error

  “Groups Create a new group Update a group Retrieve a group Retrieve group users Retrieve all groups Delete a group”

• API categories endpoints Report an error

  “Categories Create a new category Update a category Retrieve a category Retrieve all categories Delete a category”

• API articles endpoints Report an error

  “Articles Create an article Update an article Upvote an article Downvote an article Retrieve an article Retrieve all articles Delete an article”

• API activities endpoints Report an error

  “Activities Retrieve an activity Retrieve all activities”

• API settings endpoints Report an error

  “Settings Retrieve account settings Update account settings”

• API webhooks Report an error

  “Webhooks Retrieve all webhooks Retrieve a webhook Create a webhook Update a webhook Toggle a webhook Test a webhook Delete a webhook”

• API backups endpoints Report an error

  “Backups Retrieve all backups Retrieve a backup”

• API rate limit Report an error

  “We limit our API requests to 100 requests per minute.”

• Corporation Report an error

  “Helpjuice, Inc. is a registered US Corporation, EIN # 45-2275731”

Scores citing this record

• The Engineering Lead Help-center publishing & integrations
• The Engineering Lead Import, export & self-hosting
• The Engineering Lead European sovereignty
• The IT Administrator Verification, ownership & freshness
• The IT Administrator Permissions, SSO & administration
• The IT Administrator Help-center publishing & integrations
• The IT Administrator Import, export & self-hosting
• The IT Administrator European sovereignty
• The Operations Lead Permissions, SSO & administration
• The Operations Lead Help-center publishing & integrations
• The Operations Lead Import, export & self-hosting
• The Quality Manager Verification, ownership & freshness
• The Quality Manager Help-center publishing & integrations
• The Quality Manager Import, export & self-hosting
• The Quality Manager European sovereignty
• The Skeptic Verification, ownership & freshness
• The Skeptic Help-center publishing & integrations
• The Skeptic Import, export & self-hosting
• The Support Knowledge Manager Help-center publishing & integrations
• The Support Knowledge Manager Import, export & self-hosting
• The Support Knowledge Manager European sovereignty