Deployments via the API
A deployment is a variant of the widget with its own settings, such as example questions, texts and styling (see The widget on your website). Via the API you can retrieve the deployments in your environment read-only, for example to show them in your own admin screen or to select the right deployment in an integration.
This page assumes the base URL, authentication and headers from Working with the API.
Endpoints
- Retrieve a list:
GET https://{klant}.vragen.ai/api/v1/deployments - Retrieve one:
GET https://{klant}.vragen.ai/api/v1/deployments/{id}
Creating, updating or deleting via the API is not possible; you do that in your vragen.ai environment.
Fields
| Field | Meaning |
|---|---|
name |
The name of the deployment. |
slug |
The machine name you use in the embed code or link (the deployment parameter). |
build_type |
How the window appears (for example inline, overlay or side panel). |
trigger |
How the window is opened or placed. |
created_at |
When the deployment was created. |
updated_at |
When the deployment was last modified. |
Example response
GET https://{klant}.vragen.ai/api/v1/deployments
{
"data": [
{
"type": "deployments",
"id": "1",
"attributes": {
"name": "Website",
"slug": "website",
"build_type": "embed",
"trigger": "embed",
"created_at": "2026-01-15T09:00:00+00:00",
"updated_at": "2026-03-02T14:30:00+00:00"
}
}
]
}
Support
Stuck? Email our support team at service@vragen.ai.