ClickHelp User Manual

[API] Get Project/Publication

Returns information about a single project or publication.

GET projects/{id}

Authentication

This request requires basic authentication.

Request Parameters

Path params

id	string	The ID of the project/publication to retrieve information about.

Samples

Request sample

Copy Code

Bash (Unix Shell)

curl --location -g --request GET 'https://{portal-url}/api/v1/projects/project-deep-space-exploration'

Response body sample

Copy Code

JSON

{
    "createdOn": "2021-04-07T15:50:15",
    "fullUrl": "https://docs.hedronlabs.org/articles/project-deep-space-exploration",
    "id": "project-deep-space-exploration",
    "parentId": null,
    "parentUrl": null,
    "title": "Project Deep Space Exploration",
    "url": "project-deep-space-exploration",
    "visibility": "Private"
}

Response fields

createdOn	An ISO 8601 timestamp of the project/publication creation date. GMT timezone.
fullUrl	The full URL of the project or publication.
id	The unique identifier of the project or publication.
parentId	The unique identifier of the parent entity. Returns null for projects. For publications, returns the ID of the associated project.
parentUrl	[deprecated] Same as parentId.
title	The title of the project or publication.
url	[deprecated] Same as id.
visibility	The visibility of the project/publication. Always returns Private for projects.

API: Projects & Publications [API] Get All Projects and Publications