Config Fields
Get All Config Fields
About API Reference
Linked Account
Config
Config Fields
Webhooks
Session Token
Cobalt Hosted
Config Fields
Get All Config Fields
POST
/
api
/
v2
/
public
/
config
/
field
curl --request POST \
--url https://api.gocobalt.io/api/v2/public/config/field \
--header 'linked_account_id: <linked_account_id>' \
--header 'x-api-key: <api-key>'{
"slug": "pipedrive",
"config_id": "173135978",
"fields": [],
"workflows": [
{
"id": "649d9cbf71ad565d0ce8c5b6",
"name": "Create Deal",
"description": "",
"enabled": false,
"fields": [
{
"required": false,
"id": "649d9d2571ad565d0ce8c64f",
"name": "Pipeline",
"field_type": "select",
"options": [
{
"name": "Pipeline",
"value": 1
},
{
"name": "New pipeline",
"value": 3
}
],
"labels": [],
"value": 1
},
{
"required": false,
"id": "649d9d4371ad565d0ce8c68a",
"name": "Stage",
"field_type": "select",
"options": [
{
"name": "Qualified",
"value": 1
},
{
"name": "Contact Made",
"value": 2
},
{
"name": "Prospect Qualified",
"value": 3
},
{
"name": "Needs Defined",
"value": 4
}
],
"parent": "649d9d2571ad565d0ce8c64f",
"labels": [],
"value": 3
}
]
}
]
}
This API retrieves all the fields in a config for an application using its unique identifier.
Request description
Headers
Unique customer identification id. For Eg: markwood@some_email.com
If true, field options will not be returned in the response.
Path Parameters
Application Slug. Eg: docusign
Response description
Application slug
Unique ID of the created config
Global input fields of an application
Unique field id
Field display name
Field input type. Expected values: text, number, select, map
If the field is a required field.
Published workflows of the application
Workflow ID
Workflow name
Workflow description
If the workflow is enabled for the linked account
Workflow specific input fields
Unique field id
Field display name
Field input type. Expected values: text, number, select, map
If the field is a required field.
{
"slug": "pipedrive",
"config_id": "173135978",
"fields": [],
"workflows": [
{
"id": "649d9cbf71ad565d0ce8c5b6",
"name": "Create Deal",
"description": "",
"enabled": false,
"fields": [
{
"required": false,
"id": "649d9d2571ad565d0ce8c64f",
"name": "Pipeline",
"field_type": "select",
"options": [
{
"name": "Pipeline",
"value": 1
},
{
"name": "New pipeline",
"value": 3
}
],
"labels": [],
"value": 1
},
{
"required": false,
"id": "649d9d4371ad565d0ce8c68a",
"name": "Stage",
"field_type": "select",
"options": [
{
"name": "Qualified",
"value": 1
},
{
"name": "Contact Made",
"value": 2
},
{
"name": "Prospect Qualified",
"value": 3
},
{
"name": "Needs Defined",
"value": 4
}
],
"parent": "649d9d2571ad565d0ce8c64f",
"labels": [],
"value": 3
}
]
}
]
}
curl --request POST \
--url https://api.gocobalt.io/api/v2/public/config/field \
--header 'linked_account_id: <linked_account_id>' \
--header 'x-api-key: <api-key>'{
"slug": "pipedrive",
"config_id": "173135978",
"fields": [],
"workflows": [
{
"id": "649d9cbf71ad565d0ce8c5b6",
"name": "Create Deal",
"description": "",
"enabled": false,
"fields": [
{
"required": false,
"id": "649d9d2571ad565d0ce8c64f",
"name": "Pipeline",
"field_type": "select",
"options": [
{
"name": "Pipeline",
"value": 1
},
{
"name": "New pipeline",
"value": 3
}
],
"labels": [],
"value": 1
},
{
"required": false,
"id": "649d9d4371ad565d0ce8c68a",
"name": "Stage",
"field_type": "select",
"options": [
{
"name": "Qualified",
"value": 1
},
{
"name": "Contact Made",
"value": 2
},
{
"name": "Prospect Qualified",
"value": 3
},
{
"name": "Needs Defined",
"value": 4
}
],
"parent": "649d9d2571ad565d0ce8c64f",
"labels": [],
"value": 3
}
]
}
]
}