Seeds

PreviousTest NextBulk

Was this helpful?

List seeds

List all available seeds

get

/seeds

Query parameters

statusstring · enum

Filter by status

Options: available, planted, retired

domainstring · hostname

Filter by seed domain i.e. example.com

offsetinteger

Pagination offset

limitinteger · min: 1 · max: 100

Pagination limit

orderBystring

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 -L \
  --url 'https://app.seedata.io/api/seeds'

200

{
  "metadata": {
    "totalCount": 1,
    "offset": 1,
    "limit": 1
  },
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "contentType": "text",
      "slug": "yellow-jump-magic",
      "domain": "example.com",
      "description": "text",
      "plantedDescription": "text",
      "plantedLocation": "text",
      "plantedMethodId": "text",
      "muteNotificationsUntil": "2025-02-27T04:14:31.101Z",
      "locked": true,
      "eventCount": 1,
      "seedImpact": 1,
      "plantedAt": "2025-02-27T04:14:31.101Z",
      "plantedByType": "text",
      "plantedById": "123e4567-e89b-12d3-a456-426614174000",
      "retiredAt": "2025-02-27T04:14:31.101Z",
      "retiredByType": "text",
      "retiredById": "123e4567-e89b-12d3-a456-426614174000",
      "createdByType": "text",
      "createdById": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-02-27T04:14:31.101Z",
      "downloadedByType": "text",
      "downloadedById": "123e4567-e89b-12d3-a456-426614174000",
      "downloadedAt": "2025-02-27T04:14:31.101Z",
      "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2025-02-27T04:14:31.101Z",
      "externalIdentifier": "text",
      "type": "email",
      "status": "initialising",
      "contentKeywords": [
        "text"
      ],
      "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"
      }
    }
  ]
}

Get seed

Fetch a single seed by it's UUID

get

/seeds/{seedId}

Path parameters

seedIdstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "contentType": "text",
  "slug": "yellow-jump-magic",
  "domain": "example.com",
  "description": "text",
  "plantedDescription": "text",
  "plantedLocation": "text",
  "plantedMethodId": "text",
  "muteNotificationsUntil": "2025-02-27T04:14:31.101Z",
  "locked": true,
  "eventCount": 1,
  "seedImpact": 1,
  "plantedAt": "2025-02-27T04:14:31.101Z",
  "plantedByType": "text",
  "plantedById": "123e4567-e89b-12d3-a456-426614174000",
  "retiredAt": "2025-02-27T04:14:31.101Z",
  "retiredByType": "text",
  "retiredById": "123e4567-e89b-12d3-a456-426614174000",
  "createdByType": "text",
  "createdById": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-27T04:14:31.101Z",
  "downloadedByType": "text",
  "downloadedById": "123e4567-e89b-12d3-a456-426614174000",
  "downloadedAt": "2025-02-27T04:14:31.101Z",
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-02-27T04:14:31.101Z",
  "externalIdentifier": "text",
  "type": "email",
  "status": "initialising",
  "contentKeywords": [
    "text"
  ],
  "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"
  }
}

Update seed

patch

/seeds/{seedId}

Path parameters

seedIdstring · uuidrequired

Body

descriptionstring

An arbitrary user provided description for the seed.

muteNotificationsUntilstring · date-time

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

cURL

JavaScript

Python

HTTP

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

200

400

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "contentType": "text",
  "slug": "yellow-jump-magic",
  "domain": "example.com",
  "description": "text",
  "plantedDescription": "text",
  "plantedLocation": "text",
  "plantedMethodId": "text",
  "muteNotificationsUntil": "2025-02-27T04:14:31.101Z",
  "locked": true,
  "eventCount": 1,
  "seedImpact": 1,
  "plantedAt": "2025-02-27T04:14:31.101Z",
  "plantedByType": "text",
  "plantedById": "123e4567-e89b-12d3-a456-426614174000",
  "retiredAt": "2025-02-27T04:14:31.101Z",
  "retiredByType": "text",
  "retiredById": "123e4567-e89b-12d3-a456-426614174000",
  "createdByType": "text",
  "createdById": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-27T04:14:31.101Z",
  "downloadedByType": "text",
  "downloadedById": "123e4567-e89b-12d3-a456-426614174000",
  "downloadedAt": "2025-02-27T04:14:31.101Z",
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-02-27T04:14:31.101Z",
  "externalIdentifier": "text",
  "type": "email",
  "status": "initialising",
  "contentKeywords": [
    "text"
  ],
  "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"
  }
}