Sites

How to list docs-sites

Request Overview

Actions	Returns	Description
`GET` /api/v1/docs/sites	`Collection`	Get all sites

Fields

Site Object

Field	Type	Required	Specifics
`name`	`String`	yes	Some name
`url`	`String`		Domain of the site
`is_public`	`Integer 0\|1`		Indicates whether the website is publicly accessible or not.
`locale_default`	`String`		The default locale of a site.
`locales_enabled`	`Array`		Array of locales that are available in public
`is_multi_lingual`
`created_at`	`Date` `String`
`updated_at`	`Date` `String`
`last_modified_at`	`Date` `String`		Last change date of the site, its categories or articles.

Requests

Get All Sites

GET /api/v1/docs/sites Returns, a collection of sites

GET /api/v1/docs/sites HTTP/1.1
Authorization: Bearer {{token}}
Hs-Client-Id: {{hs_client_id}}
Host: api.helpspace.com
Content-Type: application/json; charset=utf-8

200 Response

HTTP/1.1 200 OK
Content-Type: application/json
...

{
  "data": [
    {
      "id": 1,
      "name": "Some name",
      "url": "http:\/\/support.domain.com",
      "is_public": "1",
      "locale_default": "en",
      "locales_enabled": [
        "en",
        "de"
      ],
      "is_multi_lingual": 1,
      "created_at": "2024-07-12T11:15:59+00:00",
      "updated_at": "2024-08-08T11:17:34+00:00",
      "last_modified_at": "2024-08-08T13:17:34+00:00"
    },
    ...
  ],
  "links": {
    ...
  },
  "meta": {
    ...
  }
}

Information about links and meta, please read this article.

Query parameters

By default, the site API will return all sites.

For example: /api/v1/docs/sites?modified-since=2024-08-08T13%3A17%3A34%2B00%3A00

	Query Parameters	Possible Values
Modified Since	?modified-since=2024-08-08T13%3A17%3A34%2B00%3A00 Returns all sites that had modifications since the given date.	`urlencoded string`

Query Parameters

Possible Values

Modified Since

?modified-since=2024-08-08T13%3A17%3A34%2B00%3A00

Returns all sites that had modifications since the given date.

urlencoded string