ChakraHQ APIs
HomeSign In
HomeSign In
  1. Platform
  • API Keys
  • Response Format
  • Whatsapp
    • Inbound Events Webhook
    • Pass Through APIs
      • Create WhatsApp Message Template (pass-through)
      • List WhatsApp Message Templates (pass-through)
      • Update WhatsApp Message Template (pass-through)
    • Send Whatsapp Template Message For Process
      POST
    • Send Whatsapp Template Message For A Phone Number
      POST
    • Upload Public Media
      POST
    • Whatsapp Messages API (pass-through)
      POST
  • Platform
    • Process
      • Fetch Process By Id
      • List Processes
      • Create Process
      • Update Process
      • Update Process By Primary Key
      • Delete Process
      • Delete Process By Primary Key Value
      • Bulk Create Process API
      • Bulk Update Process API
    • Task
      • Create Task API
    • User
      • List Users API
      • List Users API (V2)
      • Fetch User API
      • Fetch User API (V2)
      • Update User API
    • Photo
      • Fetch Photo API
      • Upload Photo API
      • Upload Photo API With Id
    • Background Job
      • Fetch Background Job
      • Fetch Background Job Entries API
    • Fetch Config
      GET
  1. Platform

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 ********************

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.chakrahq.com/v1/ext/config'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2025-05-12 09:06:35
Previous
Fetch Background Job Entries API
Built with