Skip to main content
GET
Read a project's settings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

cloudchat-instance
string
required

The CloudChat instance the account lives in, e.g. 4. Sent as a header, and required: with accountId it forms the pair that names exactly one account, which accountId alone does not. listMyCloudChatAccounts returns the value to send here alongside each accountId.

Path Parameters

project
string
required

The ClaudIA project to act on, by name. Get the names from listMyClaudiaProjects — a project these credentials do not cover answers 404, indistinguishable from one that does not exist.

Query Parameters

accountId
string
required

The CloudChat account whose permissions decide what you may read and write here, e.g. 7. It is permission context, not the resource: the project is named in the path. Only unique within an instance, so it is always read together with the cloudchat-instance header — get the pair from listMyCloudChatAccounts. An account your credentials hold no editing claim for answers 403.

Response

The settings you are allowed to read.

How one ClaudIA project behaves — the same settings the ClaudIA app shows on its settings screens. The set of keys is NOT fixed: it is whatever your role is allowed to see on this account, resolved against CloudChat on every call, so two callers reading the same project can legitimately get different keys. Read this before patching: the keys present here, minus the ones listed in readOnlyPaths, are exactly the keys updateProjectSettings accepts from you. Nested settings arrive as nested objects, and a key is addressed in readOnlyPaths, in the history and in an error as its dotted path (greetingsSettings.staticGreeting).

name
string
required

The project these settings belong to. Always present, whatever your permissions.

Example:

"acme_support"

readOnlyPaths
string[]

Dotted paths present in this response that you may read but not write. Sending one of them to updateProjectSettings is refused. Absent when there are none.

Dotted paths present in this response that you may read but not write. Sending one of them to updateProjectSettings is refused. Absent when there are none.

Example: