Get Project Config
Required scope:
public-api:read
Description
This endpoint returns the Project Config.Use Cases
- Used by Livingdocs CLI to download the Project Config
Endpoint
GET /api/2025-05/projectConfig
Response
Get Project Configuration
UseGET /api/2025-05/projectConfig
instead.
This endpoint got removed in the2025-07
version.
It’s still available on/api/2025-05/project
and older versions.
Version | Change |
---|---|
release-2023-03 | This endpoint got deprecreated. Use GET /api/v1/projectConfig instead. |
release-2025-07 | This endpoint got removed in the 2025-07 version. It’s still available on /api/2025-05/project and older versions. |
Required scope:
public-api:read
Endpoint
GET /api/2025-05/project
Response
Get Channel Configuration
UseGET /api/2025-05/projectConfig
instead.
This endpoint got removed in the2025-07
version.
It’s still available on/api/2025-05/channels/{channelHandle}
and older versions.
Version | Change |
---|---|
release-2023-03 | This endpoint got deprecated. Please use GET /api/v1/projectConfig instead. |
release-2025-07 | This endpoint got removed in the 2025-07 version. It’s still available on /api/2025-05/project and older versions. |
Required scope:
public-api:read
Endpoint
GET /api/2025-05/channels/{channelHandle}
Parameters
Name | Type | Required | Notes |
---|---|---|---|
channelHandle | string | Optional channelHandle. Will return first channel of a project if none is passed. |
Response
Get the latest Design Configuration
Required scope:
public-api:read
Endpoint
GET /api/2025-05/design
Response
Get a specific Design Configuration
Required scope:
public-api:read
Use Cases
- Load the appropriate Design Version for a document
Endpoint
GET /api/2025-05/design/{designVersion}
Parameters
Name | Type | Required | Notes |
---|---|---|---|
designVersion | string | Optional design version. Will take the current design version of a channel if none is passed. |