HEhere
Manage Spaces

List spaces

Changed on

Lists the spaces, which the current authenticated user has access to.

get/spaces

Request

  • Base URL
    /hub (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /hub/spaces
  • Auth
    • API key in query parameter access_token
    • or HTTP bearer

Query parameters

contentUpdatedAtstring

Additional space filter which compares the space's contentUpdatedAt timestamp with the one specified in the query, resulting in a subset of spaces. The format should follow the specification below

  • ?contentUpdatedAt=timestamp

The available operators are:

  • ">=" or "=gte=" - greater than or equals
  • "<=" or "=lte=" - less than or equals
  • ">" or "=gt=" - greater than
  • "<" or "=lt=" - less than
includeConnectorsboolean

If set to true, the connectors for each space are included in the response.

includeRightsboolean

If set to true, the access rights for each space are included in the response.

ownerstring

Define the owner(s) of spaces to be shown in the response. Possible values are:

  • me (The default value; Show only the spaces being owned by the current user),
  • (someOwnerId) (Only for shared spaces: Explicitly only show spaces belonging to the specified user),
  • others (Show only the spaces having been shared excluding the own ones),
  • * (Show all spaces the current user has access to)
tagstring

Filter for spaces with the given tag.

regionstring

Filter for spaces with the given region.

Response

A list of spaces.

idstring

The unique identifier of the space which consists of an (optional) prefix and a base part (prefix-base).

titlestring

The space title.

descriptionstring

The space description in markdown format.

ownerstring

The identifier of the owner of this space, most likely the HERE account ID.

sharedboolean

If set to true, every authenticated user can read the features in the space. When publishing a space it's also recommended to set the fields copyright & license.

readOnlyboolean

A flag indicating whether the space allows write operations (false) or not (true).

license'AFL-3.0' | 'Apache-2.0' | 'Artistic-2.0' | 'BSL-1.0' | 'BSD-2-Clause' | 'BSD-3-Clause' | 'BSD-3-Clause-Clear' | 'CC0-1.0' | 'CC-BY-4.0' | 'CC-BY-SA-4.0' | 'WTFPL' | 'ECL-1.0' | 'ECL-2.0' | 'EUPL-1.1' | 'AGPL-3.0-only' | 'GPL-2.0-only' | 'GPL-3.0-only' | 'LGPL-2.1-only' | 'LGPL-3.0-only' | 'ISC' | 'LPPL-1.3c' | 'MS-PL' | 'MIT' | 'MPL-2.0' | 'OSL-3.0' | 'PostgreSQL' | 'OFL-1.1' | 'NCSA' | 'Unlicense' | 'Zlib' | 'ODbL-1.0'

Information about the license bound to the data within the space.

clientSpaceClientInfo

An arbitrary object holding some hints or settings for the client, for example rendering instructions.

packagesstring[]

List of packages that this space belongs to.

cidstring

An additional identifier specifying a context of the owner.

createdAtinteger

The UNIX Epoch time of when this space has been created (in milliseconds since 01.01.1970). Defaults to October 1st, 2018.

updatedAtinteger

The UNIX Epoch time of when this space has been last updated (in milliseconds since 01.01.1970). Defaults to October 1st, 2018.

cacheTTLinteger

The maximum amount of seconds of how long to hold objects of this Space in a cache.

contentUpdatedAtinteger

The UNIX Epoch time of when the content of this space has been last updated (in milliseconds since 01.01.1970). Defaults to October 1st, 2018.

searchablePropertiesSearchableProperties

A map defined by the user that indicates, which of the feature's properties to be searchable. The key is the name of the property (nested properties can be specified using the dot-notation e.g.: some.nested.property) and the value is a boolean telling whether the property should be searchable or not. Setting the value to false the property won't be searchable at all. (Even if the property was chosen to be searchable by the automated property-search algorithm before). Optional it is possible to define the datatype (object,array,string,number,boolean) of the property eg.: some.nested.property::array. If the datatype is not given, an attempt is made to determine it automatically.

volatilityAtLastContentUpdatenumber double

The calculated volatility at the last content update time.

volatilitynumber double

An indicator, if the data in the space is edited often ( value tends to 1 ) or static ( value tends to 0 ).

rightsstring[]

The list of rights the current user has when accessing the space. This property is only shown when listing spaces with the option includeRights=true

versionsToKeepinteger

Defines how many versions will be kept, while older versions may be purged. By default this value will be set to 1. That means there will be only one (HEAD) state of the space and no further versions will be kept. If the value is bigger than 1, then older versions, up to the "versionsToKeep" version, can be retrieved by e.g. ?version=<version_number>

tagsobject

A map containing the tag ids and the respective referenced versions.

Example response

[
  {
    "title": "My Demo Space",
    "description": "Description as markdown"
  }
]

Changes

  • 3d35de5add7aRevision changes
    • warning

      removed the optional property / from the response with the status

  • c656e0e4c8dcRevision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status