API
Login Sign Up

Knowledge base Public API

Note: The API endpoints below are run against your knowledge base's default base URL (see "Settings" of your knowledge base) and do not require authentication. If your knowledge base is password or IP address protected, the requests below will fail with 404 Not Found status.

Searching articles

GET https://help.groovehq.com/help/search.json

Parameters

Name Type Required Default Notes
keyword string Yes The keyword to search articles by.

Example Request

curl -i -X GET https://help.groovehq.com/help/search.json?keyword=Custom+Domain \
    -H "Content-Type: application/json"

Example Response

Status: 200 OK

[
    {
        "title": "Adding a custom domain to your Knowledge Base",
        "url": "https://help.groovehq.com/help/adding-a-custom-domain-to-your-knowledge-base"
    },
    {
        "title": "Using your own SSL for a custom domain",
        "url": "https://help.groovehq.com/help/using-your-own-ssl-for-a-custom-domain"
    },
    {
        "title": "Groove Knowledge Base Overview",
        "url": "https://help.groovehq.com/help/groove-knowledge-base-overview"
    },
    {
        "title": "Shopify Integration",
        "url": "https://help.groovehq.com/help/shopify-integration"
    }
]

Rating articles

POST https://help.groovehq.com/help/:slug/ratings.json

Parameters

Name Type Required Default Notes
value integer Yes The rating value, either: 0, 3, 7, or 10 for ratings_type emoji or 0 or 10 for ratings_type upvote.

Example Request

curl -i -X POST https://help.groovehq.com/help/does-groove-have-an-api-2d8af3fa/ratings.json \
    -H "Content-Type: application/x-www-form-urlencoded" \
    -d 'value=10'

Example Response

Status: 201 Created

{
    "article": {
        "helpful_ratings_count": 12,
        "total_ratings_count": 88
    }
}