Seeds

List seeds

get

List all available seeds

Query parameters
statusstring · enumOptional

Filter by status

Possible values:
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:descPattern: ^[a-zA-Z0-9\_]+(:(asc|desc))?$
Responses
200
OK
application/json
get
GET /api/seeds 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": "email",
      "contentType": "text",
      "contentKeywords": [
        "text"
      ],
      "slug": "yellow-jump-magic",
      "domain": "example.com",
      "description": "text",
      "plantedDescription": "text",
      "plantedLocation": "text",
      "plantedMethodId": "text",
      "muteNotificationsUntil": "2025-06-23T22:42:11.199Z",
      "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-06-23T22:42:11.199Z",
      "plantedByType": "text",
      "plantedById": "123e4567-e89b-12d3-a456-426614174000",
      "retiredAt": "2025-06-23T22:42:11.199Z",
      "retiredByType": "text",
      "retiredById": "123e4567-e89b-12d3-a456-426614174000",
      "createdByType": "text",
      "createdById": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-06-23T22:42:11.199Z",
      "downloadedByType": "text",
      "downloadedById": "123e4567-e89b-12d3-a456-426614174000",
      "downloadedAt": "2025-06-23T22:42:11.199Z",
      "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2025-06-23T22:42:11.199Z",
      "externalIdentifier": "text"
    }
  ]
}

Get seed

get

Fetch a single seed by it's UUID

Path parameters
seedIdstring · uuidRequired
Responses
200
OK
application/json
get
GET /api/seeds/{seedId} HTTP/1.1
Host: app.seedata.io
Accept: */*
200

OK

{
  "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-06-23T22:42:11.199Z",
  "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-06-23T22:42:11.199Z",
  "plantedByType": "text",
  "plantedById": "123e4567-e89b-12d3-a456-426614174000",
  "retiredAt": "2025-06-23T22:42:11.199Z",
  "retiredByType": "text",
  "retiredById": "123e4567-e89b-12d3-a456-426614174000",
  "createdByType": "text",
  "createdById": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-06-23T22:42:11.199Z",
  "downloadedByType": "text",
  "downloadedById": "123e4567-e89b-12d3-a456-426614174000",
  "downloadedAt": "2025-06-23T22:42:11.199Z",
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-06-23T22:42:11.199Z",
  "externalIdentifier": "text"
}

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
200
OK
application/json
patch
PATCH /api/seeds/{seedId} HTTP/1.1
Host: app.seedata.io
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "description": "text",
  "muteNotificationsUntil": "2025-06-23T22:42:11.199Z"
}
{
  "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-06-23T22:42:11.199Z",
  "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-06-23T22:42:11.199Z",
  "plantedByType": "text",
  "plantedById": "123e4567-e89b-12d3-a456-426614174000",
  "retiredAt": "2025-06-23T22:42:11.199Z",
  "retiredByType": "text",
  "retiredById": "123e4567-e89b-12d3-a456-426614174000",
  "createdByType": "text",
  "createdById": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-06-23T22:42:11.199Z",
  "downloadedByType": "text",
  "downloadedById": "123e4567-e89b-12d3-a456-426614174000",
  "downloadedAt": "2025-06-23T22:42:11.199Z",
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-06-23T22:42:11.199Z",
  "externalIdentifier": "text"
}
PreviousTestNextBulk

Was this helpful?