Integrations

List Integrations

get

List of integrations

Query parameters

offsetintegerOptional

Pagination offset

limitinteger · min: 1 · max: 100Optional

Pagination limit

orderBystringOptional

Order the results by this field, in this direction

Example: createdAt:descPattern: ^[a-zA-Z0-9\_]+(:(asc|desc))?$

Responses

200

OK

application/json

get

/integrations

HTTPcURLJavaScriptPython

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": "2026-03-09T19:47:52.342Z",
      "updatedAt": "2026-03-09T19:47:52.342Z"
    }
  ]
}

Create Integration

post

Create a new integration

Body

application/json

or

Responses

201

Created

application/json

post

/integrations

HTTPcURLJavaScriptPython

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": "2026-03-09T19:47:52.342Z",
  "updatedAt": "2026-03-09T19:47:52.342Z"
}

Get integration

get

Get the integration for the organisation

Path parameters

integrationIdstring · uuidRequired

Responses

200

OK

application/json

Integration model response

idstring · uuidRead-onlyOptional

typestring · enumOptional

Integration type

Possible values:

integrationTokenstringRead-onlyOptional

Integration token

settingsone ofRead-onlyOptional

Integration settings

or

createdByTypestring · nullableRead-onlyOptional

createdByIdstring · nullableRead-onlyOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

get

/integrations/{integrationId}

HTTPcURLJavaScriptPython

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": "2026-03-09T19:47:52.342Z",
  "updatedAt": "2026-03-09T19:47:52.342Z"
}

Delete integration

delete

Delete the integration for the organisation

Path parameters

integrationIdstring · uuidRequired

Responses

204

No Content

delete

/integrations/{integrationId}

HTTPcURLJavaScriptPython

DELETE /api/integrations/{integrationId} HTTP/1.1
Host: app.seedata.io
Accept: */*

204

No Content

No content

Update integration

patch

Update the integration for the organisation

Path parameters

integrationIdstring · uuidRequired

Body

application/json

or

Responses

200

OK

application/json

Integration model response

idstring · uuidRead-onlyOptional

typestring · enumOptional

Integration type

Possible values:

integrationTokenstringRead-onlyOptional

Integration token

settingsone ofRead-onlyOptional

Integration settings

or

createdByTypestring · nullableRead-onlyOptional

createdByIdstring · nullableRead-onlyOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

patch

/integrations/{integrationId}

HTTPcURLJavaScriptPython

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": "2026-03-09T19:47:52.342Z",
  "updatedAt": "2026-03-09T19:47:52.342Z"
}