Fetch Config

GET

https://api.chakrahq.com/v1/ext/config

The following APIs give you access to the internal config.

The config api provides most of the configurations related to the data model like processes, records and tasks. List of config keys:

team

entities

procedures

attributeTypes

attributes

derivedAttributes

attributeGroups

roles

pods

taskTypes

forms

formFields

formActionButtons

stateTasks

userProfiles

attributeConfig

skillTypes

How to use this config

While interacting Chakra APIs most of the data attributes contain the shortId for the attribute keys to keep them readable like:

"name": "Harish",
"product_id": "uwf09js",
"cost": 100000,

But there will be other fields like procedure, entity, role which contain uuids. For each of these uuids the actual config can be found within the config data returned under the right key.

So schema for procedure: d7783ade-bbbe-4734-afcc-9bc869d8d8a3 can be found in the procedures array returned from the config api.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.chakrahq.com/v1/ext/config' \
--header 'Authorization: Bearer <token>'

Response Example

{}

Modified at 2025-05-12 09:06:35

Fetch Background Job Entries API

MappingType

Fetch Config

How to use this config#

Request

Responses

How to use this config