Seeds

List seeds

get

List all available seeds

Query parameters

statusstring · enumoptional

Filter by status

Available options:

domainstring · hostnameoptional

Filter by seed domain i.e. example.com

offsetintegeroptional

Pagination offset

limitinteger · min: 1 · max: 100optional

Pagination limit

orderBystringoptional

Order the results by this field, in this direction

Example: createdAt:desc

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.seedata.io/api/seeds'

200

200

{
  "metadata": {
    "totalCount": 1,
    "offset": 1,
    "limit": 1
  },
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "email",
      "contentType": "text",
      "contentKeywords": [
        "text"
      ],
      "slug": "yellow-jump-magic",
      "domain": "example.com",
      "description": "text",
      "plantedDescription": "text",
      "plantedLocation": "text",
      "plantedMethodId": "text",
      "muteNotificationsUntil": "2025-04-02T08:57:04.746Z",
      "status": "initialising",
      "locked": true,
      "eventCount": 1,
      "seedImpact": 1,
      "seedMetadata": {
        "md5SeededFileHash": "text",
        "locale": "text",
        "title": "text",
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "password": "text",
        "dob": "text",
        "company": "text",
        "phoneDialCode": "text",
        "phone": "text",
        "address": "text",
        "addressLine1": "text",
        "addressCity": "text",
        "addressCountry": "text",
        "addressZipCode": "text"
      },
      "plantedAt": "2025-04-02T08:57:04.746Z",
      "plantedByType": "text",
      "plantedById": "123e4567-e89b-12d3-a456-426614174000",
      "retiredAt": "2025-04-02T08:57:04.746Z",
      "retiredByType": "text",
      "retiredById": "123e4567-e89b-12d3-a456-426614174000",
      "createdByType": "text",
      "createdById": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-04-02T08:57:04.746Z",
      "downloadedByType": "text",
      "downloadedById": "123e4567-e89b-12d3-a456-426614174000",
      "downloadedAt": "2025-04-02T08:57:04.746Z",
      "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2025-04-02T08:57:04.746Z",
      "externalIdentifier": "text"
    }
  ]
}

OK

Get seed

get

Fetch a single seed by it's UUID

Path parameters

seedIdstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.seedata.io/api/seeds/{seedId}'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "email",
  "contentType": "text",
  "contentKeywords": [
    "text"
  ],
  "slug": "yellow-jump-magic",
  "domain": "example.com",
  "description": "text",
  "plantedDescription": "text",
  "plantedLocation": "text",
  "plantedMethodId": "text",
  "muteNotificationsUntil": "2025-04-02T08:57:04.746Z",
  "status": "initialising",
  "locked": true,
  "eventCount": 1,
  "seedImpact": 1,
  "seedMetadata": {
    "md5SeededFileHash": "text",
    "locale": "text",
    "title": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "password": "text",
    "dob": "text",
    "company": "text",
    "phoneDialCode": "text",
    "phone": "text",
    "address": "text",
    "addressLine1": "text",
    "addressCity": "text",
    "addressCountry": "text",
    "addressZipCode": "text"
  },
  "plantedAt": "2025-04-02T08:57:04.746Z",
  "plantedByType": "text",
  "plantedById": "123e4567-e89b-12d3-a456-426614174000",
  "retiredAt": "2025-04-02T08:57:04.746Z",
  "retiredByType": "text",
  "retiredById": "123e4567-e89b-12d3-a456-426614174000",
  "createdByType": "text",
  "createdById": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-04-02T08:57:04.746Z",
  "downloadedByType": "text",
  "downloadedById": "123e4567-e89b-12d3-a456-426614174000",
  "downloadedAt": "2025-04-02T08:57:04.746Z",
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-04-02T08:57:04.746Z",
  "externalIdentifier": "text"
}

OK

Update seed

patch

Path parameters

seedIdstring · uuidrequired

Body

descriptionstringoptional

An arbitrary user provided description for the seed.

muteNotificationsUntilstring · date-timeoptional

The date until which notifications for events related to this seed will be muted. The date has to be in the future, otherwise the operation will result in an error

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://app.seedata.io/api/seeds/{seedId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "text",
    "muteNotificationsUntil": "2025-04-02T08:57:04.746Z"
  }'

200

400

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "email",
  "contentType": "text",
  "contentKeywords": [
    "text"
  ],
  "slug": "yellow-jump-magic",
  "domain": "example.com",
  "description": "text",
  "plantedDescription": "text",
  "plantedLocation": "text",
  "plantedMethodId": "text",
  "muteNotificationsUntil": "2025-04-02T08:57:04.746Z",
  "status": "initialising",
  "locked": true,
  "eventCount": 1,
  "seedImpact": 1,
  "seedMetadata": {
    "md5SeededFileHash": "text",
    "locale": "text",
    "title": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "password": "text",
    "dob": "text",
    "company": "text",
    "phoneDialCode": "text",
    "phone": "text",
    "address": "text",
    "addressLine1": "text",
    "addressCity": "text",
    "addressCountry": "text",
    "addressZipCode": "text"
  },
  "plantedAt": "2025-04-02T08:57:04.746Z",
  "plantedByType": "text",
  "plantedById": "123e4567-e89b-12d3-a456-426614174000",
  "retiredAt": "2025-04-02T08:57:04.746Z",
  "retiredByType": "text",
  "retiredById": "123e4567-e89b-12d3-a456-426614174000",
  "createdByType": "text",
  "createdById": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-04-02T08:57:04.746Z",
  "downloadedByType": "text",
  "downloadedById": "123e4567-e89b-12d3-a456-426614174000",
  "downloadedAt": "2025-04-02T08:57:04.746Z",
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-04-02T08:57:04.746Z",
  "externalIdentifier": "text"
}

OK