About API Reference
Linked Account
Config
Config Fields
Webhooks
Session Token
Cobalt Hosted
Get Config by ID
curl --request GET \
--url https://api.gocobalt.io/api/v2/public/slug/:slug/config/:config_id \
--header 'linked_account_id: <linked_account_id>' \
--header 'x-api-key: <api-key>'
{
"slug": "mailerlite",
"config_id": "config_4",
"fields": [
{
"required": false,
"id": "646473c7e7b74deee820458f",
"name": "MailerLite Field Mapping",
"field_type": "map",
"options": [
{
"name": "City",
"value": "city"
},
{
"name": "Company",
"value": "company"
},
{
"name": "Country",
"value": "country"
},
{
"name": "Last name",
"value": "last_name"
},
{
"name": "Name",
"value": "name"
},
{
"name": "Phone",
"value": "phone"
}
],
"labels": [
{
"name": "Customer Name",
"value": "name"
},
{
"name": "Customer Last Name",
"value": "last_name"
},
{
"name": "Customer's Company",
"value": "company"
}
]
}
],
"workflows": [
{
"id": "649d230c2ce6b9b07b163e61",
"name": "Add a Subscriber to Mailerlite",
"description": "",
"enabled": false,
"fields": []
}
]
}
This API retrieves the config for an application using its unique identifier.
Request description
Headers
Unique customer identification id. For Eg: markwood@some_email.com
Path Parameters
Application Slug. Eg: docusign
Id of the config to be fetched. If not provided, linked_account_id
is considered by default.
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": "mailerlite",
"config_id": "config_4",
"fields": [
{
"required": false,
"id": "646473c7e7b74deee820458f",
"name": "MailerLite Field Mapping",
"field_type": "map",
"options": [
{
"name": "City",
"value": "city"
},
{
"name": "Company",
"value": "company"
},
{
"name": "Country",
"value": "country"
},
{
"name": "Last name",
"value": "last_name"
},
{
"name": "Name",
"value": "name"
},
{
"name": "Phone",
"value": "phone"
}
],
"labels": [
{
"name": "Customer Name",
"value": "name"
},
{
"name": "Customer Last Name",
"value": "last_name"
},
{
"name": "Customer's Company",
"value": "company"
}
]
}
],
"workflows": [
{
"id": "649d230c2ce6b9b07b163e61",
"name": "Add a Subscriber to Mailerlite",
"description": "",
"enabled": false,
"fields": []
}
]
}
curl --request GET \
--url https://api.gocobalt.io/api/v2/public/slug/:slug/config/:config_id \
--header 'linked_account_id: <linked_account_id>' \
--header 'x-api-key: <api-key>'
{
"slug": "mailerlite",
"config_id": "config_4",
"fields": [
{
"required": false,
"id": "646473c7e7b74deee820458f",
"name": "MailerLite Field Mapping",
"field_type": "map",
"options": [
{
"name": "City",
"value": "city"
},
{
"name": "Company",
"value": "company"
},
{
"name": "Country",
"value": "country"
},
{
"name": "Last name",
"value": "last_name"
},
{
"name": "Name",
"value": "name"
},
{
"name": "Phone",
"value": "phone"
}
],
"labels": [
{
"name": "Customer Name",
"value": "name"
},
{
"name": "Customer Last Name",
"value": "last_name"
},
{
"name": "Customer's Company",
"value": "company"
}
]
}
],
"workflows": [
{
"id": "649d230c2ce6b9b07b163e61",
"name": "Add a Subscriber to Mailerlite",
"description": "",
"enabled": false,
"fields": []
}
]
}