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
Bash (Unix Shell) |
curl --location -g --request GET 'https://{portal-url}/api/v1/projects/project-deep-space-exploration' |
Response body sample
JSON |
{ |
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.
|