Integrations

List Integrations

List of integrations

GEThttps://app.seedata.io/api/integrations

Query parameters

Response

200

OK

Body

application/json

metadatametadata

Pagination Metadata

itemsarray of Integration

Request

JavaScriptCurlPython

const response = await fetch('https://app.seedata.io/api/integrations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "metadata": {},
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "integrated_server",
      "integrationToken": "text",
      "settings": {
        "status": "active",
        "subtype": "linux"
      },
      "createdByType": "text",
      "createdById": "text",
      "createdAt": "2024-11-21T07:08:07.156Z",
      "updatedAt": "2024-11-21T07:08:07.156Z"
    }
  ]
}

Create Integration

Create a new integration

POSThttps://app.seedata.io/api/integrations

Body

application/json

one of

Web Form IntegrationServer Integration

Response

201

Created

Body

application/json

idstring (uuid)

typeenum

Integration type

integrated_serverweb_form

integrationTokenstring

Integration token

settingsobject

Integration settings

Server IntegrationWeb Form Integration

createdByTypenullable string

createdByIdnullable string

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://app.seedata.io/api/integrations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "type": "web_form",
      "seedType": "email",
      "url": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "integrated_server",
  "integrationToken": "text",
  "settings": {
    "status": "active",
    "subtype": "linux"
  },
  "createdByType": "text",
  "createdById": "text",
  "createdAt": "2024-11-21T07:08:07.156Z",
  "updatedAt": "2024-11-21T07:08:07.156Z"
}

Get integration

Get the integration for the organisation

GEThttps://app.seedata.io/api/integrations/{integrationId}

Path parameters

integrationId*string (uuid)

Response

200

OK

Body

application/json

idstring (uuid)

typeenum

Integration type

integrated_serverweb_form

integrationTokenstring

Integration token

settingsobject

Integration settings

Server IntegrationWeb Form Integration

createdByTypenullable string

createdByIdnullable string

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://app.seedata.io/api/integrations/{integrationId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "integrated_server",
  "integrationToken": "text",
  "settings": {
    "status": "active",
    "subtype": "linux"
  },
  "createdByType": "text",
  "createdById": "text",
  "createdAt": "2024-11-21T07:08:07.156Z",
  "updatedAt": "2024-11-21T07:08:07.156Z"
}

Delete integration

Delete the integration for the organisation

DELETEhttps://app.seedata.io/api/integrations/{integrationId}

Path parameters

integrationId*string (uuid)

Response

204

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://app.seedata.io/api/integrations/{integrationId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Update integration

Update the integration for the organisation

PATCHhttps://app.seedata.io/api/integrations/{integrationId}

Path parameters

integrationId*string (uuid)

Body

application/json

one of

Web Form IntegrationServer Integration

Response

200

OK

Body

application/json

idstring (uuid)

typeenum

Integration type

integrated_serverweb_form

integrationTokenstring

Integration token

settingsobject

Integration settings

Server IntegrationWeb Form Integration

createdByTypenullable string

createdByIdnullable string

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://app.seedata.io/api/integrations/{integrationId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "type": "web_form",
      "seedType": "email",
      "url": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "integrated_server",
  "integrationToken": "text",
  "settings": {
    "status": "active",
    "subtype": "linux"
  },
  "createdByType": "text",
  "createdById": "text",
  "createdAt": "2024-11-21T07:08:07.156Z",
  "updatedAt": "2024-11-21T07:08:07.156Z"
}