Integrations
List of integrations
Query parameters
offsetintegerOptional
Pagination offset
limitinteger · min: 1 · max: 100Optional
Pagination limit
orderBystringOptionalExample:
Order the results by this field, in this direction
createdAt:desc
Pattern: ^[a-zA-Z0-9\_]+(:(asc|desc))?$
Responses
200
OK
application/json
get
GET /api/integrations HTTP/1.1
Host: app.seedata.io
Accept: */*
200
OK
{
"metadata": {
"totalCount": 1,
"offset": 1,
"limit": 1
},
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "integrated_server",
"integrationToken": "text",
"settings": {
"status": "active",
"subtype": "linux"
},
"createdByType": "text",
"createdById": "text",
"createdAt": "2025-06-24T09:13:30.369Z",
"updatedAt": "2025-06-24T09:13:30.369Z"
}
]
}
Create a new integration
Body
one ofOptional
or
Responses
201
Created
application/json
post
POST /api/integrations HTTP/1.1
Host: app.seedata.io
Content-Type: application/json
Accept: */*
Content-Length: 185
{
"name": "text",
"description": "text",
"type": "web_form",
"seedType": "email",
"url": "text",
"headers": [
{
"key": "text",
"value": "text"
}
],
"fieldMappings": [
{
"from": "text",
"to": "text",
"length": 1
}
]
}
201
Created
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "integrated_server",
"integrationToken": "text",
"settings": {
"status": "active",
"subtype": "linux"
},
"createdByType": "text",
"createdById": "text",
"createdAt": "2025-06-24T09:13:30.369Z",
"updatedAt": "2025-06-24T09:13:30.369Z"
}
Get the integration for the organisation
Path parameters
integrationIdstring · uuidRequired
Responses
200
OK
application/json
get
GET /api/integrations/{integrationId} HTTP/1.1
Host: app.seedata.io
Accept: */*
200
OK
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "integrated_server",
"integrationToken": "text",
"settings": {
"status": "active",
"subtype": "linux"
},
"createdByType": "text",
"createdById": "text",
"createdAt": "2025-06-24T09:13:30.369Z",
"updatedAt": "2025-06-24T09:13:30.369Z"
}
Update the integration for the organisation
Path parameters
integrationIdstring · uuidRequired
Body
one ofOptional
or
Responses
200
OK
application/json
patch
PATCH /api/integrations/{integrationId} HTTP/1.1
Host: app.seedata.io
Content-Type: application/json
Accept: */*
Content-Length: 185
{
"name": "text",
"description": "text",
"type": "web_form",
"seedType": "email",
"url": "text",
"headers": [
{
"key": "text",
"value": "text"
}
],
"fieldMappings": [
{
"from": "text",
"to": "text",
"length": 1
}
]
}
200
OK
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "integrated_server",
"integrationToken": "text",
"settings": {
"status": "active",
"subtype": "linux"
},
"createdByType": "text",
"createdById": "text",
"createdAt": "2025-06-24T09:13:30.369Z",
"updatedAt": "2025-06-24T09:13:30.369Z"
}
Last updated
Was this helpful?