API de Growwer

GET /api/v1/me

Your account

Profile basics, the buyer and seller balances, whether your seller account is restricted, whether the catalogue is open to you, and whether you have a managed service.

Respuestas

• 200

  Your account.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/me" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "id": "00000000-0000-0000-0000-000000000000",
  "email": "[email protected]",
  "firstName": "string",
  "language": "en",
  "createdAt": "2026-01-01T00:00:00+00:00",
  "buyer": {
    "balance": {
      "available": {
        "amount": 12500,
        "currency": "EUR"
      },
      "pending": {
        "amount": 12500,
        "currency": "EUR"
      }
    }
  },
  "seller": {
    "balance": {
      "available": {
        "amount": 12500,
        "currency": "EUR"
      },
      "pending": {
        "amount": 12500,
        "currency": "EUR"
      }
    },
    "restricted": false,
    "onHoliday": false,
    "holidayEndDate": "2026-01-01"
  },
  "catalogue": {
    "eligible": false
  },
  "managedService": {
    "active": false
  }
}

PUT /api/v1/seller/holiday

Set your holiday

Starts, changes or ends your holiday, as the holiday settings of your profile page do. While you are on holiday your medias take no orders. endDate is the day your holiday ends, at 00:00 of that day in Growwer's server time, and must be later than now; leave it out, or send null, for a holiday you end yourself. Ending the holiday takes no endDate.

A holiday that already is as you ask is answered 200 without a change. A restricted seller account stays on holiday until the restriction is lifted, so any change is refused. Your holiday is also in GET /me.

Parámetros

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 200

  Your holiday, as it now is.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 409

  Your seller account is restricted, so its holiday cannot change (code seller_restricted), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 422

  The body is not valid (code validation_failed): an endDate that is not a later day, or one sent with onHoliday false.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X PUT "https://tool.growwer.com/api/v1/seller/holiday" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "onHoliday": false,
  "endDate": "2026-12-01"
}'

{
  "onHoliday": false,
  "endDate": "2026-01-01"
}

GET /api/v1/vocabulary

Codes and names

The countries, languages, topics, product types, link types and order states that other operations take and return. Names are in English.

Respuestas

• 200

  Every code, with its English name where it has one.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/vocabulary" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "countries": [
    {
      "code": "string",
      "name": "string"
    }
  ],
  "languages": [
    {
      "code": "string",
      "name": "string"
    }
  ],
  "topics": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "productTypes": [
    "post_order"
  ],
  "linkTypes": [
    "dofollow"
  ],
  "orderStates": [
    "string"
  ]
}

GET /api/v1/projects/{id}/saved-filters

List the saved filters of a project

Your saved filters of one of your projects, newest first, including those saved on the web. A project has at most 100. Apply one with savedFilterId on GET /projects/{id}/medias.

Parámetros

Respuestas

• 200

  The saved filters and how many there are.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/projects/$PROJECT_ID/saved-filters" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "activeFilterCount": 0,
      "notifications": {
        "enabled": false,
        "frequency": "instant"
      },
      "createdAt": "2026-01-01T00:00:00+00:00"
    }
  ],
  "total": 0
}

POST /api/v1/projects/{id}/saved-filters

Save a filter

Saves a catalogue search of one of your projects, which then also appears on the web. filters takes the filter parameters of GET /projects/{id}/medias, and source, with the same values; lists may be JSON arrays and flags JSON booleans. With notificationFrequency, Growwer emails you new medias that match. A project has at most 100 saved filters and an account 500.

Parámetros

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 201

  The saved filter.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The project already has 100 saved filters, or the account 500 (code saved_filter_limit_reached), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/projects/$PROJECT_ID/saved-filters" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "filters": {
    "language": [
      "es"
    ],
    "minDomainRating": 30,
    "favourite": true
  },
  "notificationFrequency": "daily"
}'

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "activeFilterCount": 0,
  "notifications": {
    "enabled": false,
    "frequency": "instant"
  },
  "createdAt": "2026-01-01T00:00:00+00:00"
}

DELETE /api/v1/projects/{id}/saved-filters/{filterId}

Delete a saved filter

Deletes one of your saved filters of one of your projects, including one saved on the web. Its notifications stop.

Parámetros

Respuestas

• 204

  The saved filter was deleted.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X DELETE "https://tool.growwer.com/api/v1/projects/$PROJECT_ID/saved-filters/$FILTER_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

GET /api/v1/projects/{id}/saved-filters/{filterId}/media-count

Count the medias of a saved filter

How many medias of the project's catalogue one of your saved filters matches: the total of GET /projects/{id}/medias with its savedFilterId. The number is cached for up to 24 hours, and it can differ from the count the web shows, which is not limited to the project's catalogue. A filter saved on the web that uses a filter the API does not support is refused with 422 saved_filter_unsupported.

Parámetros

Respuestas

• 200

  The number of matching medias.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 422

  The saved filter uses a web filter the API does not support (code saved_filter_unsupported); details.field names it.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/projects/$PROJECT_ID/saved-filters/$FILTER_ID/media-count" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "count": 0
}

GET /api/v1/flash-offers

List flash offers

The medias on a flash offer, a time-limited discount, in the catalogue of one of your projects. It is GET /projects/{id}/medias with flashOffer=true, and takes the same parameters except flashOffer and savedFilterId. The catalogue access and the daily distinct-media limit of that operation apply.

Parámetros

Respuestas

• 200

  A page of flash offers and how many there are in all.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The catalogue is open to accounts with recent completed orders, as buyer or as seller, and this account has none (code catalogue_requires_recent_order). GET /me reports catalogue.eligible.

• 404

  The resource does not exist, or it is not yours (code not_found).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/flash-offers?projectId=$PROJECT_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "domain": "example.com",
      "type": "blog",
      "language": "string",
      "country": "string",
      "topics": [
        0
      ],
      "metrics": {
        "organicTraffic": 0,
        "domainRating": 0,
        "referringDomains": 0,
        "linkedDomains": 0,
        "linkedToReferringRatio": 0
      },
      "positiveTrafficTrend": false,
      "bestSeller": false,
      "publicationRate": 0,
      "averageDaysToPublication": 0,
      "onHoliday": false,
      "flashOffer": {
        "discountPercent": 0,
        "endsAt": "2026-01-01T00:00:00+00:00"
      },
      "postOffer": {
        "price": {
          "amount": null,
          "currency": null
        },
        "linkType": "dofollow",
        "prices": {},
        "previousPrice": {
          "amount": null,
          "currency": null
        },
        "advertisingLabel": false,
        "promotedSocialNetworks": [
          "twitter"
        ],
        "extras": {
          "homepageListing": null,
          "sensitiveTopic": null
        }
      },
      "linkAdditionOffer": {
        "price": {
          "amount": null,
          "currency": null
        },
        "linkType": "dofollow",
        "prices": {},
        "previousPrice": {
          "amount": null,
          "currency": null
        }
      },
      "project": {
        "favourite": false,
        "discarded": false,
        "requested": false,
        "recommended": false,
        "bought": false,
        "new": false
      }
    }
  ],
  "total": 0
}

GET /api/v1/medias/{id}

Get a media

One media of the catalogue: an active, public media. A media you have ordered is always readable, even if it has since left the catalogue, and is open to every account. Otherwise the catalogue is open to accounts with recent completed orders (see catalogue.eligible on GET /me), and the media counts towards the distinct medias the account may see per day (UTC). For the media's state in one of your projects, search the project with GET /projects/{id}/medias.

Parámetros

Respuestas

• 200

  The media.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The catalogue is open to accounts with recent completed orders, as buyer or as seller, and this account has none (code catalogue_requires_recent_order). GET /me reports catalogue.eligible.

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/medias/$MEDIA_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "id": "00000000-0000-0000-0000-000000000000",
  "domain": "example.com",
  "type": "blog",
  "language": "string",
  "country": "string",
  "topics": [
    0
  ],
  "metrics": {
    "organicTraffic": 0,
    "domainRating": 0,
    "referringDomains": 0,
    "linkedDomains": 0,
    "linkedToReferringRatio": 0
  },
  "positiveTrafficTrend": false,
  "bestSeller": false,
  "publicationRate": 0,
  "averageDaysToPublication": 0,
  "onHoliday": false,
  "flashOffer": {
    "discountPercent": 0,
    "endsAt": "2026-01-01T00:00:00+00:00"
  },
  "postOffer": {
    "price": {
      "amount": 12500,
      "currency": "EUR"
    },
    "linkType": "dofollow",
    "prices": {},
    "previousPrice": {
      "amount": 12500,
      "currency": "EUR"
    },
    "advertisingLabel": false,
    "promotedSocialNetworks": [
      "twitter"
    ],
    "extras": {
      "homepageListing": {
        "amount": 12500,
        "currency": "EUR"
      },
      "sensitiveTopic": {
        "allowed": false,
        "extraPrice": {
          "amount": null,
          "currency": null
        }
      }
    }
  },
  "linkAdditionOffer": {
    "price": {
      "amount": 12500,
      "currency": "EUR"
    },
    "linkType": "dofollow",
    "prices": {},
    "previousPrice": {
      "amount": 12500,
      "currency": "EUR"
    }
  }
}

PUT /api/v1/projects/{id}/discards/{mediaId}

Discard a media for a project

Discards a media for one of your projects, as the web does. Discarding it again changes nothing. The media must be one the catalogue shows for the project: another media, including one of your own as a seller, is answered as not found.

Parámetros

Respuestas

• 204

  The media is discarded for the project.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X PUT "https://tool.growwer.com/api/v1/projects/$PROJECT_ID/discards/$MEDIA_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

DELETE /api/v1/projects/{id}/discards/{mediaId}

Restore a discarded media for a project

Restores a media you discarded for one of your projects. Restoring one that is not discarded changes nothing. It works for any media, even one the catalogue no longer shows.

Parámetros

Respuestas

• 204

  The media is not discarded for the project.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X DELETE "https://tool.growwer.com/api/v1/projects/$PROJECT_ID/discards/$MEDIA_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

PUT /api/v1/projects/{id}/favourites/{mediaId}

Add a media to the favourites of a project

Marks a media as a favourite of one of your projects, as the heart on the web does. Adding a favourite again changes nothing. The media must be one the catalogue shows for the project: another media, including one of your own as a seller, is answered as not found.

Parámetros

Respuestas

• 204

  The media is a favourite of the project.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X PUT "https://tool.growwer.com/api/v1/projects/$PROJECT_ID/favourites/$MEDIA_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

DELETE /api/v1/projects/{id}/favourites/{mediaId}

Remove a media from the favourites of a project

Removes a media from the favourites of one of your projects. Removing one that is not a favourite changes nothing. It works for any media, even one the catalogue no longer shows.

Parámetros

Respuestas

• 204

  The media is not a favourite of the project.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X DELETE "https://tool.growwer.com/api/v1/projects/$PROJECT_ID/favourites/$MEDIA_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

POST /api/v1/projects/{id}/media-requests

Request specific medias for a project

Asks Growwer to find the medias of these domains for one of your projects, as the "request specific domains" form on the web does. Each entry may be a domain or a URL; it is read as its full domain, lowercased. Repeated domains are requested once, and a domain already requested changes nothing. Up to 200 distinct domains per call. They then appear in the project's catalogue with project.requested true (requested=true on GET /projects/{id}/medias) once Growwer lists them.

Parámetros

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 201

  The domains were requested: each distinct domain, as Growwer read it.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/projects/$PROJECT_ID/media-requests" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "domains": [
    "example.com"
  ]
}'

{
  "domains": [
    "string"
  ]
}

GET /api/v1/projects/{id}/medias

Search the catalogue for a project

The medias the catalogue offers for one of your projects, as the web lists them, with each media's state in the project. Filter with the parameters below, which all combine, or apply one of your saved filters with savedFilterId alone. The catalogue is open to accounts with recent completed orders (see catalogue.eligible on GET /me), and each account can see a limited number of distinct medias per day (UTC) across the catalogue operations; medias seen again the same day are free.

Parámetros

Respuestas

• 200

  A page of matching medias and how many match in all.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The catalogue is open to accounts with recent completed orders, as buyer or as seller, and this account has none (code catalogue_requires_recent_order). GET /me reports catalogue.eligible.

• 404

  The resource does not exist, or it is not yours (code not_found).

• 422

  A parameter is not valid (code validation_failed; details.fields names it), or the saved filter uses a web filter the API does not support (code saved_filter_unsupported; details.field names it).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/projects/$PROJECT_ID/medias" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "domain": "example.com",
      "type": "blog",
      "language": "string",
      "country": "string",
      "topics": [
        0
      ],
      "metrics": {
        "organicTraffic": 0,
        "domainRating": 0,
        "referringDomains": 0,
        "linkedDomains": 0,
        "linkedToReferringRatio": 0
      },
      "positiveTrafficTrend": false,
      "bestSeller": false,
      "publicationRate": 0,
      "averageDaysToPublication": 0,
      "onHoliday": false,
      "flashOffer": {
        "discountPercent": 0,
        "endsAt": "2026-01-01T00:00:00+00:00"
      },
      "postOffer": {
        "price": {
          "amount": null,
          "currency": null
        },
        "linkType": "dofollow",
        "prices": {},
        "previousPrice": {
          "amount": null,
          "currency": null
        },
        "advertisingLabel": false,
        "promotedSocialNetworks": [
          "twitter"
        ],
        "extras": {
          "homepageListing": null,
          "sensitiveTopic": null
        }
      },
      "linkAdditionOffer": {
        "price": {
          "amount": null,
          "currency": null
        },
        "linkType": "dofollow",
        "prices": {},
        "previousPrice": {
          "amount": null,
          "currency": null
        }
      },
      "project": {
        "favourite": false,
        "discarded": false,
        "requested": false,
        "recommended": false,
        "bought": false,
        "new": false
      }
    }
  ],
  "total": 0
}

POST /api/v1/files

Upload a file

Uploads a document (odt, doc, docx or txt, up to 8 MB) for a later write to reference by its id. A file belongs to you, can be used by one write, and expires 24 hours after it was uploaded; an expired or used file is answered like an unknown one.

Parámetros

Cuerpo de la petición multipart/form-data, Obligatorio

Respuestas

• 201

  The file, stored until expiresAt.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).

• 409

  The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).

• 422

  No file was sent as the file field, or it is too large, not an odt, doc, docx or txt document, or its name is longer than 255 characters (code validation_failed).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/files" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -F "[email protected]"

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "size": 0,
  "expiresAt": "2026-01-01T00:00:00+00:00"
}

GET /api/v1/invoices

List your invoices

The invoices of your top-ups, newest first.

Parámetros

Respuestas

• 200

  A page of your invoices and how many you have in all.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/invoices" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "number": "string",
      "issuedAt": "2026-01-01T00:00:00+00:00",
      "total": {
        "amount": 12500,
        "currency": "EUR"
      }
    }
  ],
  "total": 0
}

GET /api/v1/invoices/{id}/pdf

Download an invoice

The PDF of one of your invoices.

Parámetros

Respuestas

• 200

  The invoice.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/invoices/$INVOICE_ID/pdf" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -o invoice.pdf

GET /api/v1/wallets/buyer

Get your buyer wallet

The balance you buy with, and the page where you top it up.

Respuestas

• 200

  Your buyer wallet.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/wallets/buyer" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "balance": {
    "available": {
      "amount": 12500,
      "currency": "EUR"
    },
    "pending": {
      "amount": 12500,
      "currency": "EUR"
    }
  },
  "topUpUrl": "https://example.com"
}

GET /api/v1/wallets/buyer/transactions

List your buyer wallet movements

Every movement of your buyer wallet, newest first: top-ups, order debits and their refunds, gifts and manual corrections.

Parámetros

Respuestas

• 200

  A page of your movements and how many there are in all.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/wallets/buyer/transactions" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "string",
      "state": "pending_confirmation",
      "direction": "credit",
      "amount": {
        "amount": 12500,
        "currency": "EUR"
      },
      "description": "string",
      "descriptionCode": "string",
      "orderId": "00000000-0000-0000-0000-000000000000",
      "invoiceId": "00000000-0000-0000-0000-000000000000",
      "hasDocument": false,
      "createdAt": "2026-01-01T00:00:00+00:00",
      "updatedAt": "2026-01-01T00:00:00+00:00"
    }
  ],
  "total": 0
}

GET /api/v1/wallets/buyer/transactions/{id}/document

Download the document of a wallet movement

The document Growwer attached to a movement of your buyer wallet. 404 when the movement has none (hasDocument is false) or the file cannot be read.

Parámetros

Respuestas

• 200

  The document, with its own content type and name.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/wallets/buyer/transactions/$TRANSACTION_ID/document" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -o document

POST /api/v1/managed-service/campaign-requests

Request a new campaign

Asks your account manager for a new campaign, as the managed service page does: the team emails you to agree on it. For accounts with a managed service (GET /me managedService.active); without one, POST /managed-service/info-requests asks about the service.

You may send 5 such requests per UTC day through the API. Past them it answers 429 managed_service_request_limit_reached, with Retry-After the time to the next UTC midnight. A request that is refused (4xx) does not count; one that fails on the server (5xx) does, as it may have been sent.

Parámetros

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 202

  The request was sent.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 409

  You have no managed service yet (code managed_service_required), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/managed-service/campaign-requests" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "projectUrl": "string",
  "goal": "link_building",
  "country": "string",
  "duration": "one_time",
  "estimatedBudget": {
    "amount": 12500,
    "currency": "EUR"
  },
  "additionalInfo": "example example"
}'

{
  "status": "sent"
}

GET /api/v1/managed-service/campaigns

List your managed service campaigns

The campaigns your managed service runs for you, newest first. Without a managed service the list is empty: GET /me says whether you have one.

Parámetros

Respuestas

• 200

  A page of your campaigns and how many you have in all.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/managed-service/campaigns" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "state": "pending_proposal_delivery",
      "deadline": "2026-01-01T00:00:00+00:00",
      "budget": {
        "amount": 12500,
        "currency": "EUR"
      },
      "project": {
        "id": "00000000-0000-0000-0000-000000000000",
        "url": "string"
      },
      "strategy": {
        "goal": "link_building",
        "countries": [],
        "languages": [],
        "topics": [],
        "definition": "string"
      },
      "proposalCounts": {
        "proposed": 0,
        "accepted": 0,
        "cancelled": 0,
        "purchase_started": 0,
        "purchase_finished": 0
      },
      "proposalsTotal": {
        "amount": 12500,
        "currency": "EUR"
      },
      "budgetExceededBy": {
        "amount": 12500,
        "currency": "EUR"
      },
      "createdAt": "2026-01-01T00:00:00+00:00",
      "updatedAt": "2026-01-01T00:00:00+00:00"
    }
  ],
  "total": 0
}

GET /api/v1/managed-service/campaigns/{id}

Get a managed service campaign

Parámetros

Respuestas

• 200

  The campaign.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/managed-service/campaigns/$CAMPAIGN_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "state": "pending_proposal_delivery",
  "deadline": "2026-01-01T00:00:00+00:00",
  "budget": {
    "amount": 12500,
    "currency": "EUR"
  },
  "project": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "strategy": {
    "goal": "link_building",
    "countries": [
      "string"
    ],
    "languages": [
      "string"
    ],
    "topics": [
      0
    ],
    "definition": "string"
  },
  "proposalCounts": {
    "proposed": 0,
    "accepted": 0,
    "cancelled": 0,
    "purchase_started": 0,
    "purchase_finished": 0
  },
  "proposalsTotal": {
    "amount": 12500,
    "currency": "EUR"
  },
  "budgetExceededBy": {
    "amount": 12500,
    "currency": "EUR"
  },
  "createdAt": "2026-01-01T00:00:00+00:00",
  "updatedAt": "2026-01-01T00:00:00+00:00"
}

GET /api/v1/managed-service/campaigns/{id}/proposals

List the proposals of a campaign

The medias the team proposes for the campaign, newest first. Those proposed await your review (POST /managed-service/campaigns/{id}/proposals/review).

Parámetros

Respuestas

• 200

  A page of the campaign's proposals and how many match in all.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/managed-service/campaigns/$CAMPAIGN_ID/proposals" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "state": "proposed",
      "media": {
        "id": "00000000-0000-0000-0000-000000000000",
        "domain": "string",
        "language": "string",
        "country": "string"
      },
      "service": "post",
      "proposedPrice": {
        "amount": 12500,
        "currency": "EUR"
      },
      "currentPrice": {
        "amount": 12500,
        "currency": "EUR"
      },
      "briefing": {
        "mainInfo": "string",
        "links": [],
        "additionalInfo": "string",
        "requiresDraft": false
      },
      "stateReason": "string",
      "orderId": "00000000-0000-0000-0000-000000000000",
      "orderState": "string",
      "createdAt": "2026-01-01T00:00:00+00:00",
      "updatedAt": "2026-01-01T00:00:00+00:00"
    }
  ],
  "total": 0
}

GET /api/v1/managed-service/campaigns/{id}/proposals-summary

Download the summary of a campaign's proposals

The PDF the campaign page offers: the proposals awaiting your review, accepted or being published, newest first, in your language. With extended=true it also shows each proposal's price, the price it was proposed at (proposedPrice).

Parámetros

Respuestas

• 200

  The summary.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/managed-service/campaigns/$CAMPAIGN_ID/proposals-summary" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -o proposals-summary.pdf

POST /api/v1/managed-service/campaigns/{id}/proposals/estimate

Estimate accepting proposals

Totals the campaign's accepted proposals that still await their order and the proposed ones you name in accept, and compares the total with your wallet's available balance. Each proposal counts at its currentPrice, or at its proposedPrice when the media no longer offers the service. Nothing is accepted, charged or reserved, so a read-only key may call it and it takes no Idempotency-Key.

The estimate is advisory: accepting a proposal charges nothing. The team charges your wallet when it places the order for an accepted proposal, and the same balance pays for the orders you place yourself.

Parámetros

Cuerpo de la petición application/json, Opcional

Respuestas

• 200

  The totals and how your wallet covers them.

• 400

  The body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The campaign is not yours, or a proposal named in accept is not one of the campaign's (code not_found, with details.proposalId).

• 409

  A proposal named in accept is not awaiting your review (code invalid_state, with details.proposalIds).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/managed-service/campaigns/$CAMPAIGN_ID/proposals/estimate" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accept": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

{
  "acceptedTotal": {
    "amount": 12500,
    "currency": "EUR"
  },
  "selectedTotal": {
    "amount": 12500,
    "currency": "EUR"
  },
  "total": {
    "amount": 12500,
    "currency": "EUR"
  },
  "availableBalance": {
    "amount": 12500,
    "currency": "EUR"
  },
  "missing": {
    "amount": 12500,
    "currency": "EUR"
  },
  "sufficientBalance": false
}

POST /api/v1/managed-service/campaigns/{id}/proposals/review

Accept or reject proposals

Decides on every proposal of the campaign that awaits your review (state proposed), as the campaign page does: name each one once, with accept or reject, and a comment for the team to reject one. Their order in the body does not matter. Accepting charges nothing: the team places the orders for the accepted proposals and your wallet pays for them then. POST /managed-service/campaigns/{id}/proposals/estimate says what they would cost.

When every proposal is accepted the campaign moves to proposal_accepted; when one is rejected the team is told and prepares others. A proposal someone else moved on the campaign page while the request ran is answered in the state it reached.

Parámetros

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 200

  The campaign and the proposals you reviewed, as they now are.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 404

  The campaign is not yours, or a proposal named is not one of the campaign's (code not_found, with details.proposalId).

• 409

  No proposal of the campaign awaits your review (code no_pending_proposals), or a proposal named does not (code invalid_state, with details.proposalIds), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 422

  The body is invalid (code validation_failed), or it leaves out proposals awaiting your review (code review_incomplete, with details.missingProposalIds).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/managed-service/campaigns/$CAMPAIGN_ID/proposals/review" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "reviews": [
    {
      "proposalId": "00000000-0000-0000-0000-000000000000",
      "decision": "accept",
      "comment": "string"
    }
  ]
}'

POST /api/v1/managed-service/info-requests

Ask about the managed service

Asks the team about the managed service for your website, as the managed service landing page does: the team contacts you. For accounts without a managed service (GET /me managedService.active); with one, POST /managed-service/campaign-requests requests a new campaign.

You may send 5 such requests per UTC day through the API. Past them it answers 429 managed_service_request_limit_reached, with Retry-After the time to the next UTC midnight. A request that is refused (4xx) does not count; one that fails on the server (5xx) does, as it may have been sent.

Parámetros

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 202

  The request was sent.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 409

  You already have a managed service (code managed_service_exists), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/managed-service/info-requests" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "projectUrl": "string",
  "goal": "link_building",
  "country": "string",
  "duration": "one_time",
  "estimatedBudget": {
    "amount": 12500,
    "currency": "EUR"
  },
  "additionalInfo": "example example"
}'

{
  "status": "sent"
}

GET /api/v1/orders

List your orders

The orders you bought, newest first by default. To follow your orders, poll with sort=updatedAt and updatedSince set to the updatedAt of the last order you saw: an order moves to the end of that list each time it changes state.

Parámetros

Respuestas

• 200

  A page of your orders and how many match in all.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/orders" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "reference": "string",
      "type": "post",
      "state": "string",
      "pendingAction": "buyer",
      "price": {
        "amount": 12500,
        "currency": "EUR"
      },
      "project": {
        "id": "00000000-0000-0000-0000-000000000000",
        "url": "string"
      },
      "media": {
        "id": "00000000-0000-0000-0000-000000000000",
        "url": "string"
      },
      "createdAt": "2026-01-01T00:00:00+00:00",
      "updatedAt": "2026-01-01T00:00:00+00:00",
      "scheduledPublicationDate": "2026-01-01T00:00:00+00:00",
      "delivery": {
        "url": "string",
        "publishedAt": "2026-01-01T00:00:00+00:00"
      },
      "briefing": {
        "title": "string",
        "language": "string",
        "links": [],
        "extraServices": [
          "list_on_homepage"
        ],
        "additionalInfo": "string",
        "hasProposedDraft": false
      },
      "draft": {
        "authoredByBuyer": false,
        "reviewable": false,
        "hasFile": false
      },
      "stateHistory": [
        {
          "state": null,
          "date": null,
          "reason": null
        }
      ],
      "channel": {
        "created": "api"
      }
    }
  ],
  "total": 0
}

POST /api/v1/orders

Place an order

Places an order on a media for one of your projects and pays its price from your wallet's available balance, as ordering on the web does. Estimate the order first (POST /orders/estimate) and send the price it answers as expectedPrice: the order is placed only at that price.

Placing the same order (same project, media, type and price) again within 5 seconds of one still in progress is refused with duplicate_order. Its details.orderId is the earlier order, or null when that order has finished or was deleted since.

A proposed draft (proposedDraftFileId, from POST /files) is used up when the order is placed. If the order is then refused because another request changed your balance, the media or its price, or placed the same order, the file is used up all the same and the refusal's message says so: upload it again before retrying.

Parámetros

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 201

  The order, placed and paid. Location is its URL.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 404

  The project is not yours, or the media does not exist or is not one you can order for this project (code not_found).

• 409

  The order cannot be placed, and nothing was charged:

  • price_changed: the price is not expectedPrice; details.currentPrice is the price.
  • insufficient_balance: your available balance does not cover the price; details has required, available and missing (Money).
  • duplicate_order: the same order was placed seconds ago; details.orderId is that order, or null.
  • seller_on_holiday: the media is not taking orders right now.
  • media_topic_not_allowed: the media does not accept the project's topic.
  • offer_unavailable: the media does not offer this type of order.
  • idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown: the Idempotency-Key conflicts.
• 422

  The body is not valid (code validation_failed, with the messages of each field in details.fields), or proposedDraftFileId names no file you can use: it does not exist, has expired or was already used (code file_unusable).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/orders" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "post",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "mediaId": "00000000-0000-0000-0000-000000000000",
  "briefing": {
    "links": [
      {
        "targetUrl": "string",
        "anchor": "string",
        "type": "dofollow"
      }
    ],
    "extraServices": [
      "list_on_homepage"
    ],
    "title": "string",
    "additionalInfo": "string"
  },
  "scheduledPublicationDate": "2026-01-01",
  "draftReviewable": false,
  "proposedDraftFileId": "00000000-0000-0000-0000-000000000000",
  "expectedPrice": {
    "amount": 12500,
    "currency": "EUR"
  }
}'

{
  "id": "00000000-0000-0000-0000-000000000000",
  "reference": "string",
  "type": "post",
  "state": "string",
  "pendingAction": "buyer",
  "price": {
    "amount": 12500,
    "currency": "EUR"
  },
  "project": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "media": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "createdAt": "2026-01-01T00:00:00+00:00",
  "updatedAt": "2026-01-01T00:00:00+00:00",
  "scheduledPublicationDate": "2026-01-01T00:00:00+00:00",
  "delivery": {
    "url": "string",
    "publishedAt": "2026-01-01T00:00:00+00:00"
  },
  "briefing": {
    "title": "string",
    "language": "string",
    "links": [
      {
        "targetUrl": "string",
        "anchor": "string",
        "type": "dofollow"
      }
    ],
    "extraServices": [
      "list_on_homepage"
    ],
    "additionalInfo": "string",
    "hasProposedDraft": false
  },
  "draft": {
    "authoredByBuyer": false,
    "reviewable": false,
    "hasFile": false
  },
  "stateHistory": [
    {
      "state": "string",
      "date": "2026-01-01T00:00:00+00:00",
      "reason": {
        "code": "other_reasons",
        "additionalInfo": "string"
      }
    }
  ],
  "channel": {
    "created": "api"
  }
}

POST /api/v1/orders/estimate

Estimate an order

Checks and prices the order POST /orders would place with the same body, without expectedPrice, and compares the price with your wallet's available balance. Nothing is placed, charged or used up, so a read-only key may call it and it takes no Idempotency-Key. Send the price it answers as expectedPrice when you place the order.

The estimate is refused for the same reasons as the order itself, except a balance that does not cover the price: that is answered here with sufficientBalance: false and the missing amount.

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 200

  The price of the order and how your wallet covers it.

• 400

  The body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The project is not yours, or the media does not exist or is not one you can order for this project (code not_found).

• 409

  The order could not be placed:

  • seller_on_holiday: the media is not taking orders right now.
  • media_topic_not_allowed: the media does not accept the project's topic.
  • offer_unavailable: the media does not offer this type of order.
• 422

  The body is not valid (code validation_failed, with the messages of each field in details.fields), or proposedDraftFileId names no file you can use: it does not exist, has expired or was already used (code file_unusable).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/orders/estimate" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "post",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "mediaId": "00000000-0000-0000-0000-000000000000",
  "briefing": {
    "links": [
      {
        "targetUrl": "string",
        "anchor": "string",
        "type": "dofollow"
      }
    ],
    "extraServices": [
      "list_on_homepage"
    ],
    "title": "string",
    "additionalInfo": "string"
  },
  "scheduledPublicationDate": "2026-01-01",
  "draftReviewable": false,
  "proposedDraftFileId": "00000000-0000-0000-0000-000000000000"
}'

{
  "price": {
    "amount": 12500,
    "currency": "EUR"
  },
  "availableBalance": {
    "amount": 12500,
    "currency": "EUR"
  },
  "missing": {
    "amount": 12500,
    "currency": "EUR"
  },
  "sufficientBalance": false
}

GET /api/v1/orders/{id}

Get an order

One order you bought, with its briefing, its draft and its state history.

Parámetros

Respuestas

• 200

  The order.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/orders/$ORDER_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "id": "00000000-0000-0000-0000-000000000000",
  "reference": "string",
  "type": "post",
  "state": "string",
  "pendingAction": "buyer",
  "price": {
    "amount": 12500,
    "currency": "EUR"
  },
  "project": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "media": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "createdAt": "2026-01-01T00:00:00+00:00",
  "updatedAt": "2026-01-01T00:00:00+00:00",
  "scheduledPublicationDate": "2026-01-01T00:00:00+00:00",
  "delivery": {
    "url": "string",
    "publishedAt": "2026-01-01T00:00:00+00:00"
  },
  "briefing": {
    "title": "string",
    "language": "string",
    "links": [
      {
        "targetUrl": "string",
        "anchor": "string",
        "type": "dofollow"
      }
    ],
    "extraServices": [
      "list_on_homepage"
    ],
    "additionalInfo": "string",
    "hasProposedDraft": false
  },
  "draft": {
    "authoredByBuyer": false,
    "reviewable": false,
    "hasFile": false
  },
  "stateHistory": [
    {
      "state": "string",
      "date": "2026-01-01T00:00:00+00:00",
      "reason": {
        "code": "other_reasons",
        "additionalInfo": "string"
      }
    }
  ],
  "channel": {
    "created": "api"
  }
}

POST /api/v1/orders/{id}/approve

Approve an order's delivery

Approves the delivery of an order whose pendingAction is yours to review the delivery, as the web does. The order finishes and the seller is paid. It takes no body.

Parámetros

Respuestas

• 200

  The order, approved.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The order is not pending your review of its delivery (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/orders/$ORDER_ID/approve" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

{
  "id": "00000000-0000-0000-0000-000000000000",
  "reference": "string",
  "type": "post",
  "state": "string",
  "pendingAction": "buyer",
  "price": {
    "amount": 12500,
    "currency": "EUR"
  },
  "project": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "media": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "createdAt": "2026-01-01T00:00:00+00:00",
  "updatedAt": "2026-01-01T00:00:00+00:00",
  "scheduledPublicationDate": "2026-01-01T00:00:00+00:00",
  "delivery": {
    "url": "string",
    "publishedAt": "2026-01-01T00:00:00+00:00"
  },
  "briefing": {
    "title": "string",
    "language": "string",
    "links": [
      {
        "targetUrl": "string",
        "anchor": "string",
        "type": "dofollow"
      }
    ],
    "extraServices": [
      "list_on_homepage"
    ],
    "additionalInfo": "string",
    "hasProposedDraft": false
  },
  "draft": {
    "authoredByBuyer": false,
    "reviewable": false,
    "hasFile": false
  },
  "stateHistory": [
    {
      "state": "string",
      "date": "2026-01-01T00:00:00+00:00",
      "reason": {
        "code": "other_reasons",
        "additionalInfo": "string"
      }
    }
  ],
  "channel": {
    "created": "api"
  }
}

POST /api/v1/orders/{id}/approve-draft

Approve a draft

Approves the draft of a post order whose pendingAction is yours to review the draft (GET /orders/{id}/draft downloads it), as the web does. The seller then publishes it. It takes no body.

Parámetros

Respuestas

• 200

  The order, with its draft approved.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The order is not a post order with a draft pending your review (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/orders/$ORDER_ID/approve-draft" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

{
  "id": "00000000-0000-0000-0000-000000000000",
  "reference": "string",
  "type": "post",
  "state": "string",
  "pendingAction": "buyer",
  "price": {
    "amount": 12500,
    "currency": "EUR"
  },
  "project": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "media": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "createdAt": "2026-01-01T00:00:00+00:00",
  "updatedAt": "2026-01-01T00:00:00+00:00",
  "scheduledPublicationDate": "2026-01-01T00:00:00+00:00",
  "delivery": {
    "url": "string",
    "publishedAt": "2026-01-01T00:00:00+00:00"
  },
  "briefing": {
    "title": "string",
    "language": "string",
    "links": [
      {
        "targetUrl": "string",
        "anchor": "string",
        "type": "dofollow"
      }
    ],
    "extraServices": [
      "list_on_homepage"
    ],
    "additionalInfo": "string",
    "hasProposedDraft": false
  },
  "draft": {
    "authoredByBuyer": false,
    "reviewable": false,
    "hasFile": false
  },
  "stateHistory": [
    {
      "state": "string",
      "date": "2026-01-01T00:00:00+00:00",
      "reason": {
        "code": "other_reasons",
        "additionalInfo": "string"
      }
    }
  ],
  "channel": {
    "created": "api"
  }
}

GET /api/v1/orders/{id}/briefing

Download the draft you attached to an order

The file you attached to the briefing of a post order. 404 when the order has none (briefing.hasProposedDraft is false) or the file cannot be read.

Parámetros

Respuestas

• 200

  The file, with its own content type and name.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/orders/$ORDER_ID/briefing" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -o briefing

POST /api/v1/orders/{id}/cancel

Cancel an order

Cancels an order the seller has not accepted yet (state pending_acceptance), as the web does. Its price returns to your wallet's available balance, and the seller is told your reason.

Parámetros

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 200

  The order, cancelled.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The seller has already accepted or refused the order, or it has finished (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/orders/$ORDER_ID/cancel" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "example example"
}'

{
  "id": "00000000-0000-0000-0000-000000000000",
  "reference": "string",
  "type": "post",
  "state": "string",
  "pendingAction": "buyer",
  "price": {
    "amount": 12500,
    "currency": "EUR"
  },
  "project": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "media": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "createdAt": "2026-01-01T00:00:00+00:00",
  "updatedAt": "2026-01-01T00:00:00+00:00",
  "scheduledPublicationDate": "2026-01-01T00:00:00+00:00",
  "delivery": {
    "url": "string",
    "publishedAt": "2026-01-01T00:00:00+00:00"
  },
  "briefing": {
    "title": "string",
    "language": "string",
    "links": [
      {
        "targetUrl": "string",
        "anchor": "string",
        "type": "dofollow"
      }
    ],
    "extraServices": [
      "list_on_homepage"
    ],
    "additionalInfo": "string",
    "hasProposedDraft": false
  },
  "draft": {
    "authoredByBuyer": false,
    "reviewable": false,
    "hasFile": false
  },
  "stateHistory": [
    {
      "state": "string",
      "date": "2026-01-01T00:00:00+00:00",
      "reason": {
        "code": "other_reasons",
        "additionalInfo": "string"
      }
    }
  ],
  "channel": {
    "created": "api"
  }
}

GET /api/v1/orders/{id}/draft

Download the draft of an order

The file of the current draft of a post order. 404 when the order has no draft file (draft.hasFile is false) or the file cannot be read.

Parámetros

Respuestas

• 200

  The file, with its own content type and name.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/orders/$ORDER_ID/draft" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -o draft

POST /api/v1/orders/{id}/request-draft-update

Request changes to a draft

Asks the seller to change the draft of a post order whose pendingAction is yours to review the draft, as the web does. The seller is told your reason.

Parámetros

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 200

  The order, with its draft back with the seller.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The order is not a post order with a draft pending your review (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/orders/$ORDER_ID/request-draft-update" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "example example"
}'

{
  "id": "00000000-0000-0000-0000-000000000000",
  "reference": "string",
  "type": "post",
  "state": "string",
  "pendingAction": "buyer",
  "price": {
    "amount": 12500,
    "currency": "EUR"
  },
  "project": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "media": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "createdAt": "2026-01-01T00:00:00+00:00",
  "updatedAt": "2026-01-01T00:00:00+00:00",
  "scheduledPublicationDate": "2026-01-01T00:00:00+00:00",
  "delivery": {
    "url": "string",
    "publishedAt": "2026-01-01T00:00:00+00:00"
  },
  "briefing": {
    "title": "string",
    "language": "string",
    "links": [
      {
        "targetUrl": "string",
        "anchor": "string",
        "type": "dofollow"
      }
    ],
    "extraServices": [
      "list_on_homepage"
    ],
    "additionalInfo": "string",
    "hasProposedDraft": false
  },
  "draft": {
    "authoredByBuyer": false,
    "reviewable": false,
    "hasFile": false
  },
  "stateHistory": [
    {
      "state": "string",
      "date": "2026-01-01T00:00:00+00:00",
      "reason": {
        "code": "other_reasons",
        "additionalInfo": "string"
      }
    }
  ],
  "channel": {
    "created": "api"
  }
}

POST /api/v1/orders/{id}/request-update

Request changes to a delivery

Asks the seller to change the delivery of an order whose pendingAction is yours to review the delivery, as the web does. The seller is told your reason.

Parámetros

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 200

  The order, back with the seller.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The order is not pending your review of its delivery (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/orders/$ORDER_ID/request-update" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "example example"
}'

{
  "id": "00000000-0000-0000-0000-000000000000",
  "reference": "string",
  "type": "post",
  "state": "string",
  "pendingAction": "buyer",
  "price": {
    "amount": 12500,
    "currency": "EUR"
  },
  "project": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "media": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "createdAt": "2026-01-01T00:00:00+00:00",
  "updatedAt": "2026-01-01T00:00:00+00:00",
  "scheduledPublicationDate": "2026-01-01T00:00:00+00:00",
  "delivery": {
    "url": "string",
    "publishedAt": "2026-01-01T00:00:00+00:00"
  },
  "briefing": {
    "title": "string",
    "language": "string",
    "links": [
      {
        "targetUrl": "string",
        "anchor": "string",
        "type": "dofollow"
      }
    ],
    "extraServices": [
      "list_on_homepage"
    ],
    "additionalInfo": "string",
    "hasProposedDraft": false
  },
  "draft": {
    "authoredByBuyer": false,
    "reviewable": false,
    "hasFile": false
  },
  "stateHistory": [
    {
      "state": "string",
      "date": "2026-01-01T00:00:00+00:00",
      "reason": {
        "code": "other_reasons",
        "additionalInfo": "string"
      }
    }
  ],
  "channel": {
    "created": "api"
  }
}

GET /api/v1/projects

List your projects

Your projects, newest first.

Parámetros

Respuestas

• 200

  A page of your projects and how many you have in all.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/projects" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "rootUrl": "https://example.com",
      "websiteType": "ecommerce",
      "topics": [
        0
      ],
      "language": "es",
      "country": "ES",
      "promotedProducts": [
        "string"
      ],
      "userKeywords": [
        "string"
      ],
      "state": "analyzing",
      "createdAt": "2026-01-01T00:00:00+00:00"
    }
  ],
  "total": 0
}

POST /api/v1/projects

Create a project

Creates a project for a website, as the web's project creation does. Growwer then analyses it in the background to recommend media: the project is answered with state: analyzing and turns finished when the analysis ends. Analysis can take hours, and it never finishes when no medium matches the project, so poll GET /projects/{id} with backoff and use createdAt to decide when to stop.

Every value is validated as on the web: topics, language and country take the identifiers GET /vocabulary publishes.

Creating a project also categorises its website through an external service, as the web does. When that service fails the answer is 500, although the project may already be saved, and a retry under the same Idempotency-Key answers 409 idempotency_outcome_unknown. After either, list your projects (GET /projects) before retrying with a new key, or you may create a duplicate.

Parámetros

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 202

  The project, created and being analysed. Location is its URL.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability), or you have reached the number of projects an account may have without a wallet deposit in the last year (code project_limit_reached).

• 409

  The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/projects" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "rootUrl": "https://www.example.com",
  "websiteType": "ecommerce",
  "topics": [
    0
  ],
  "language": "es",
  "country": "ES",
  "promotedProducts": [
    "string 1",
    "string 2",
    "string 3",
    "string 4",
    "string 5"
  ],
  "userKeywords": [
    "string"
  ]
}'

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "rootUrl": "https://example.com",
  "websiteType": "ecommerce",
  "topics": [
    0
  ],
  "language": "es",
  "country": "ES",
  "promotedProducts": [
    "string"
  ],
  "userKeywords": [
    "string"
  ],
  "state": "analyzing",
  "createdAt": "2026-01-01T00:00:00+00:00"
}

GET /api/v1/projects/{id}

Get a project

One of your projects. Poll it to follow state after creating the project.

Parámetros

Respuestas

• 200

  The project.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/projects/$PROJECT_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "rootUrl": "https://example.com",
  "websiteType": "ecommerce",
  "topics": [
    0
  ],
  "language": "es",
  "country": "ES",
  "promotedProducts": [
    "string"
  ],
  "userKeywords": [
    "string"
  ],
  "state": "analyzing",
  "createdAt": "2026-01-01T00:00:00+00:00"
}

PATCH /api/v1/projects/{id}

Edit a project

Changes only the fields you send. rootUrl cannot be changed; any field not listed here is refused. Changing language, country, promotedProducts or topics makes Growwer categorise the project and work out its target keywords again, in the background.

Parámetros

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 200

  The project as edited.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The Idempotency-Key was used for a different request (code idempotency_key_reused), its first request is still running (code idempotency_request_in_progress), or its first request failed and may have taken effect (code idempotency_outcome_unknown).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X PATCH "https://tool.growwer.com/api/v1/projects/$PROJECT_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "websiteType": "ecommerce",
  "topics": [
    0
  ],
  "language": "string",
  "country": "string",
  "promotedProducts": [
    "string 1",
    "string 2",
    "string 3",
    "string 4",
    "string 5"
  ],
  "userKeywords": [
    "string"
  ]
}'

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "rootUrl": "https://example.com",
  "websiteType": "ecommerce",
  "topics": [
    0
  ],
  "language": "es",
  "country": "ES",
  "promotedProducts": [
    "string"
  ],
  "userKeywords": [
    "string"
  ],
  "state": "analyzing",
  "createdAt": "2026-01-01T00:00:00+00:00"
}

DELETE /api/v1/projects/{id}

Delete a project

Deletes one of your projects. A project with an order in progress cannot be deleted until its orders finish.

Parámetros

Respuestas

• 204

  The project was deleted.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key lacks the capability the operation needs (code insufficient_capability), or the account may not perform it (code forbidden).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The project has an order in progress (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X DELETE "https://tool.growwer.com/api/v1/projects/$PROJECT_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

GET /api/v1/seller/medias

List the medias you sell on

Your medias in every state, with your fees and how they perform, newest first by default.

Parámetros

Respuestas

• 200

  A page of your medias and how many match in all.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/seller/medias" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "domain": "example.com",
      "url": "string",
      "state": "analyzing",
      "deactivationStrikes": 0,
      "country": "string",
      "language": "string",
      "topics": [
        0
      ],
      "bannedTopics": [
        0
      ],
      "providerComments": "string",
      "publicationRate": 0,
      "averageDaysToPublication": 0,
      "numPublishedOrders": 0,
      "onHoliday": false,
      "flashOffer": {
        "discountPercent": 0,
        "endsAt": "2026-01-01T00:00:00+00:00"
      },
      "postOffer": {
        "pricingOptions": [],
        "extraServices": []
      },
      "linkAdditionOffer": {
        "pricingOptions": []
      },
      "competitiveFees": {
        "feeWhenSellerWritesPost": {
          "amount": null,
          "currency": null
        },
        "feeWhenSellerDoesNotWritePost": {
          "amount": null,
          "currency": null
        }
      },
      "createdAt": "2026-01-01T00:00:00+00:00"
    }
  ],
  "total": 0
}

GET /api/v1/seller/medias/{id}

Get a media you sell on

One of your medias, with your fees, its extras, the competitive fees Growwer suggests and how it performs. Another seller's media is not found.

Parámetros

Respuestas

• 200

  The media.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/seller/medias/$MEDIA_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "id": "00000000-0000-0000-0000-000000000000",
  "domain": "example.com",
  "url": "string",
  "state": "analyzing",
  "deactivationStrikes": 0,
  "country": "string",
  "language": "string",
  "topics": [
    0
  ],
  "bannedTopics": [
    0
  ],
  "providerComments": "string",
  "publicationRate": 0,
  "averageDaysToPublication": 0,
  "numPublishedOrders": 0,
  "onHoliday": false,
  "flashOffer": {
    "discountPercent": 0,
    "endsAt": "2026-01-01T00:00:00+00:00"
  },
  "postOffer": {
    "pricingOptions": [
      {
        "feeWhenSellerWritesPost": {
          "amount": null,
          "currency": null
        },
        "feeWhenSellerDoesNotWritePost": {
          "amount": null,
          "currency": null
        },
        "linkType": "dofollow",
        "currentCost": {
          "amount": null,
          "currency": null
        }
      }
    ],
    "extraServices": [
      {
        "name": "list_on_homepage",
        "cost": {
          "amount": null,
          "currency": null
        }
      }
    ]
  },
  "linkAdditionOffer": {
    "pricingOptions": [
      {
        "linkType": "dofollow",
        "fee": {
          "amount": null,
          "currency": null
        },
        "currentCost": {
          "amount": null,
          "currency": null
        }
      }
    ]
  },
  "competitiveFees": {
    "feeWhenSellerWritesPost": {
      "amount": 12500,
      "currency": "EUR"
    },
    "feeWhenSellerDoesNotWritePost": {
      "amount": 12500,
      "currency": "EUR"
    }
  },
  "createdAt": "2026-01-01T00:00:00+00:00"
}

PATCH /api/v1/seller/medias/{id}

Edit the fees of a media you sell on

Sets the fees of one of your medias, as the media edit page saves them. Send only the sections you change: a section you send replaces that section wholly, a section you leave out stays as it is.

• postOffer.pricingOptions lists every link type you offer for sponsored posts, at least one. A link type you leave out is no longer offered. Each option needs at least one fee, and every option must offer the same sides (written by you, written by the buyer or Growwer), as the page requires. Each fee is at least 1 EUR.
• linkAdditionOffer.pricingOptions lists the link types you offer for adding a link to an existing article; null or an empty list stops offering link additions.
• extraServices is the full list of extra services you offer; an empty list removes them all.

The fees are your base fees, the ones GET /seller/medias/{id} returns: while a flash offer runs, its discount keeps applying on top of them, and currentCost shows the result. currentCost may be sent back as read and is ignored. Characteristics, topics and comments are not edited here.

As on the page, a change of the post offer's price may cancel the managed-service proposals accepted for the media whose price it changes, and raising the price above the best competitor's tells Growwer's support team. A restricted seller account may edit its fees.

Parámetros

Cuerpo de la petición application/json, Obligatorio

Respuestas

• 200

  The media, with the fees saved.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 422

  The body is not valid (code validation_failed): details.fields names each field by its path in the body, such as postOffer.pricingOptions.0.feeWhenSellerWritesPost, with the rule the media edit page applies. Nothing changed.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X PATCH "https://tool.growwer.com/api/v1/seller/medias/$MEDIA_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "postOffer": {
    "pricingOptions": [
      {
        "linkType": "dofollow",
        "feeWhenSellerWritesPost": {
          "amount": 12000,
          "currency": "EUR"
        },
        "feeWhenSellerDoesNotWritePost": {
          "amount": 10000,
          "currency": "EUR"
        }
      },
      {
        "linkType": "nofollow",
        "feeWhenSellerWritesPost": {
          "amount": 9000,
          "currency": "EUR"
        },
        "feeWhenSellerDoesNotWritePost": {
          "amount": 7000,
          "currency": "EUR"
        }
      }
    ]
  },
  "linkAdditionOffer": null,
  "extraServices": [
    {
      "name": "list_on_homepage",
      "cost": {
        "amount": 5000,
        "currency": "EUR"
      }
    }
  ]
}'

{
  "id": "00000000-0000-0000-0000-000000000000",
  "domain": "example.com",
  "url": "string",
  "state": "analyzing",
  "deactivationStrikes": 0,
  "country": "string",
  "language": "string",
  "topics": [
    0
  ],
  "bannedTopics": [
    0
  ],
  "providerComments": "string",
  "publicationRate": 0,
  "averageDaysToPublication": 0,
  "numPublishedOrders": 0,
  "onHoliday": false,
  "flashOffer": {
    "discountPercent": 0,
    "endsAt": "2026-01-01T00:00:00+00:00"
  },
  "postOffer": {
    "pricingOptions": [
      {
        "feeWhenSellerWritesPost": {
          "amount": null,
          "currency": null
        },
        "feeWhenSellerDoesNotWritePost": {
          "amount": null,
          "currency": null
        },
        "linkType": "dofollow",
        "currentCost": {
          "amount": null,
          "currency": null
        }
      }
    ],
    "extraServices": [
      {
        "name": "list_on_homepage",
        "cost": {
          "amount": null,
          "currency": null
        }
      }
    ]
  },
  "linkAdditionOffer": {
    "pricingOptions": [
      {
        "linkType": "dofollow",
        "fee": {
          "amount": null,
          "currency": null
        },
        "currentCost": {
          "amount": null,
          "currency": null
        }
      }
    ]
  },
  "competitiveFees": {
    "feeWhenSellerWritesPost": {
      "amount": 12500,
      "currency": "EUR"
    },
    "feeWhenSellerDoesNotWritePost": {
      "amount": 12500,
      "currency": "EUR"
    }
  },
  "createdAt": "2026-01-01T00:00:00+00:00"
}

POST /api/v1/seller/medias/{id}/apply-competitive-fees

Set the competitive fees Growwer suggests

Sets your post fees for the media to the competitive fees Growwer suggests, the competitiveFees of GET /seller/medias/{id}, as the button on the media edit page does. Each link type you offer gets the suggested fee on each side it already has a fee for; no link type gains a side it did not offer.

Two differences from the page: a side Growwer has no suggestion for keeps your fee (the page clears it), and the fixed fee the page falls back to when it cannot find a competitive one is never applied (the page applies it). When neither side has a suggestion, nothing changes and the answer is 409 no_competitive_fees. When your fees already are the suggested ones, or the suggestion is only for a side none of your link types offers, nothing changes and the answer is 200.

The fees set are your base fees: a running flash offer keeps discounting them. As with a fee edit, a change of the price may cancel the managed-service proposals accepted for the media whose price it changes. Send no body, or an empty object.

Parámetros

Respuestas

• 200

  The media, with the suggested fees set.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  Growwer has no competitive fees to suggest for the media now (code no_competitive_fees), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 422

  The body is not empty, or the fees set break a rule of the media edit page (code validation_failed). Nothing changed.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/seller/medias/$MEDIA_ID/apply-competitive-fees" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

{
  "id": "00000000-0000-0000-0000-000000000000",
  "domain": "example.com",
  "url": "string",
  "state": "analyzing",
  "deactivationStrikes": 0,
  "country": "string",
  "language": "string",
  "topics": [
    0
  ],
  "bannedTopics": [
    0
  ],
  "providerComments": "string",
  "publicationRate": 0,
  "averageDaysToPublication": 0,
  "numPublishedOrders": 0,
  "onHoliday": false,
  "flashOffer": {
    "discountPercent": 0,
    "endsAt": "2026-01-01T00:00:00+00:00"
  },
  "postOffer": {
    "pricingOptions": [
      {
        "feeWhenSellerWritesPost": {
          "amount": null,
          "currency": null
        },
        "feeWhenSellerDoesNotWritePost": {
          "amount": null,
          "currency": null
        },
        "linkType": "dofollow",
        "currentCost": {
          "amount": null,
          "currency": null
        }
      }
    ],
    "extraServices": [
      {
        "name": "list_on_homepage",
        "cost": {
          "amount": null,
          "currency": null
        }
      }
    ]
  },
  "linkAdditionOffer": {
    "pricingOptions": [
      {
        "linkType": "dofollow",
        "fee": {
          "amount": null,
          "currency": null
        },
        "currentCost": {
          "amount": null,
          "currency": null
        }
      }
    ]
  },
  "competitiveFees": {
    "feeWhenSellerWritesPost": {
      "amount": 12500,
      "currency": "EUR"
    },
    "feeWhenSellerDoesNotWritePost": {
      "amount": 12500,
      "currency": "EUR"
    }
  },
  "createdAt": "2026-01-01T00:00:00+00:00"
}

GET /api/v1/wallets/seller

Get your seller wallet

What your sales have earned: the balance you can withdraw now and what is held until orders settle. restricted is true while your seller account is restricted; the reason is not published here, and support can tell you more.

Respuestas

• 200

  Your seller wallet.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/wallets/seller" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "balance": {
    "available": {
      "amount": 12500,
      "currency": "EUR"
    },
    "pending": {
      "amount": 12500,
      "currency": "EUR"
    }
  },
  "restricted": false
}

GET /api/v1/wallets/seller/transactions

List your seller wallet movements

Every movement of your seller wallet, newest first: earnings from orders, withdrawals and manual corrections. An earning names its order (orderId) and a withdrawal its request (withdrawalId).

Parámetros

Respuestas

• 200

  A page of your movements and how many there are in all.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/wallets/seller/transactions" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "string",
      "state": "pending_confirmation",
      "direction": "credit",
      "amount": {
        "amount": 12500,
        "currency": "EUR"
      },
      "description": "string",
      "orderId": "00000000-0000-0000-0000-000000000000",
      "withdrawalId": "00000000-0000-0000-0000-000000000000",
      "hasDocument": false,
      "createdAt": "2026-01-01T00:00:00+00:00",
      "updatedAt": "2026-01-01T00:00:00+00:00"
    }
  ],
  "total": 0
}

GET /api/v1/wallets/seller/transactions/{id}/document

Download the document of a seller wallet movement

The document Growwer attached to a movement of your seller wallet. 404 when the movement has none (hasDocument is false) or the file cannot be read.

Parámetros

Respuestas

• 200

  The document, with its own content type and name.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/wallets/seller/transactions/$TRANSACTION_ID/document" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -o document

GET /api/v1/withdrawals

List your withdrawals

The withdrawals you requested from your seller wallet, newest first. Requesting a withdrawal is not available through the API; use the seller wallet page.

Parámetros

Respuestas

• 200

  A page of your withdrawals and how many match in all.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/withdrawals" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "state": "started",
      "amount": {
        "amount": 12500,
        "currency": "EUR"
      },
      "method": "bank_transfer",
      "hasInvoice": false,
      "createdAt": "2026-01-01T00:00:00+00:00"
    }
  ],
  "total": 0
}

GET /api/v1/withdrawals/{id}/invoice

Download the invoice of a withdrawal

The invoice you uploaded for one of your withdrawals, named withdrawal-{id}-invoice.pdf. 404 when the withdrawal has none (hasInvoice is false); 503 storage_unavailable when the file cannot be read right now.

Parámetros

Respuestas

• 200

  The invoice file.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/withdrawals/$WITHDRAWAL_ID/invoice" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -o invoice

GET /api/v1/seller/orders

List the orders you sell

The orders placed on your medias, newest first by default. To follow them, poll with sort=updatedAt and updatedSince set to the updatedAt of the last order you saw: an order moves to the end of that list each time it changes state. The orders you bought are under GET /orders.

Parámetros

Respuestas

• 200

  A page of the orders you sell and how many match in all.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/seller/orders" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "reference": "string",
      "type": "post",
      "state": "string",
      "requiresYourAction": false,
      "availableActions": [
        "accept"
      ],
      "earnings": {
        "amount": 12500,
        "currency": "EUR"
      },
      "project": {
        "url": "string"
      },
      "media": {
        "id": "00000000-0000-0000-0000-000000000000",
        "url": "string"
      },
      "createdAt": "2026-01-01T00:00:00+00:00",
      "updatedAt": "2026-01-01T00:00:00+00:00",
      "scheduledPublicationDate": "2026-01-01T00:00:00+00:00",
      "delivery": {
        "url": "string",
        "publishedAt": "2026-01-01T00:00:00+00:00"
      },
      "briefing": {
        "title": "string",
        "language": "string",
        "links": [],
        "extraServices": [
          "list_on_homepage"
        ],
        "additionalInfo": "string",
        "writtenBy": "seller",
        "hasProposedDraft": false
      },
      "draft": {
        "reviewable": false,
        "hasFile": false
      },
      "stateHistory": [
        {
          "state": null,
          "date": null,
          "reason": null
        }
      ],
      "channel": {
        "created": "api",
        "accepted": "api"
      }
    }
  ],
  "total": 0
}

GET /api/v1/seller/orders/{id}

Get an order you sell

One order placed on one of your medias, with its briefing, its draft and its state history. An order you only bought is not found here; it is under GET /orders/{id}.

Parámetros

Respuestas

• 200

  The order.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/seller/orders/$ORDER_ID" \
  -H "Authorization: Bearer $GROWWER_API_KEY"

{
  "id": "00000000-0000-0000-0000-000000000000",
  "reference": "string",
  "type": "post",
  "state": "string",
  "requiresYourAction": false,
  "availableActions": [
    "accept"
  ],
  "earnings": {
    "amount": 12500,
    "currency": "EUR"
  },
  "project": {
    "url": "string"
  },
  "media": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "createdAt": "2026-01-01T00:00:00+00:00",
  "updatedAt": "2026-01-01T00:00:00+00:00",
  "scheduledPublicationDate": "2026-01-01T00:00:00+00:00",
  "delivery": {
    "url": "string",
    "publishedAt": "2026-01-01T00:00:00+00:00"
  },
  "briefing": {
    "title": "string",
    "language": "string",
    "links": [
      {
        "targetUrl": "string",
        "anchor": "string",
        "type": "dofollow"
      }
    ],
    "extraServices": [
      "list_on_homepage"
    ],
    "additionalInfo": "string",
    "writtenBy": "seller",
    "hasProposedDraft": false
  },
  "draft": {
    "reviewable": false,
    "hasFile": false
  },
  "stateHistory": [
    {
      "state": "string",
      "date": "2026-01-01T00:00:00+00:00",
      "reason": {
        "code": "other_reasons",
        "additionalInfo": "string"
      }
    }
  ],
  "channel": {
    "created": "api",
    "accepted": "api"
  }
}

POST /api/v1/seller/orders/{id}/accept

Accept an order

Accepts an order placed on one of your medias (state pending_acceptance), as the web does. A post order whose draft is still to be written (by you or by Growwer) moves to pending_draft; any other order moves to pending_order_delivery. The buyer is told. Takes no body.

Parámetros

Respuestas

• 200

  The order, accepted.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The order is not waiting for your acceptance (code invalid_state), your seller account is restricted and accepts no orders (code seller_restricted; support can tell you why), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/seller/orders/$ORDER_ID/accept" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

{
  "id": "00000000-0000-0000-0000-000000000000",
  "reference": "string",
  "type": "post",
  "state": "string",
  "requiresYourAction": false,
  "availableActions": [
    "accept"
  ],
  "earnings": {
    "amount": 12500,
    "currency": "EUR"
  },
  "project": {
    "url": "string"
  },
  "media": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "createdAt": "2026-01-01T00:00:00+00:00",
  "updatedAt": "2026-01-01T00:00:00+00:00",
  "scheduledPublicationDate": "2026-01-01T00:00:00+00:00",
  "delivery": {
    "url": "string",
    "publishedAt": "2026-01-01T00:00:00+00:00"
  },
  "briefing": {
    "title": "string",
    "language": "string",
    "links": [
      {
        "targetUrl": "string",
        "anchor": "string",
        "type": "dofollow"
      }
    ],
    "extraServices": [
      "list_on_homepage"
    ],
    "additionalInfo": "string",
    "writtenBy": "seller",
    "hasProposedDraft": false
  },
  "draft": {
    "reviewable": false,
    "hasFile": false
  },
  "stateHistory": [
    {
      "state": "string",
      "date": "2026-01-01T00:00:00+00:00",
      "reason": {
        "code": "other_reasons",
        "additionalInfo": "string"
      }
    }
  ],
  "channel": {
    "created": "api",
    "accepted": "api"
  }
}

GET /api/v1/seller/orders/{id}/briefing

Download the draft the buyer attached to an order

The file the buyer attached to the briefing of a post order you sell. 404 when the order has none (briefing.hasProposedDraft is false) or the file cannot be read.

Parámetros

Respuestas

• 200

  The file, with its own content type and name.

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X GET "https://tool.growwer.com/api/v1/seller/orders/$ORDER_ID/briefing" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -o briefing

POST /api/v1/seller/orders/{id}/deliver

Deliver an order

Delivers an order placed on one of your medias (state pending_order_delivery), as the web does. A post order takes the URL of the published post and the confirmation of its publication date; a link addition order takes no body, and any field is refused. The order moves to pending_order_delivery_review and the buyer is asked to review it, or, for a post order whose scheduled publication date is still to come, to scheduled without telling the buyer yet. The URL is checked to be a URL only, as the web does.

Parámetros

Cuerpo de la petición application/json, Opcional

Respuestas

• 200

  The order, delivered or scheduled.

• 400

  The write has no Idempotency-Key header (code idempotency_key_required), the header is not 1 to 255 printable ASCII characters without spaces (code invalid_idempotency_key), or the body is not a JSON object (code invalid_json).

• 401

  The API key is missing, malformed, unknown, revoked or expired, or its account cannot sign in (code unauthorized).

• 403

  The key is read-only (code insufficient_capability).

• 404

  The resource does not exist, or it is not yours (code not_found).

• 409

  The order is not waiting for its delivery (code invalid_state), or the Idempotency-Key conflicts (codes idempotency_key_reused, idempotency_request_in_progress, idempotency_outcome_unknown).

• 422

  The request is not valid (code validation_failed). details.fields holds the messages for each invalid field, by field name.

• 429

  Over the rate limit (code rate_limit_exceeded), or too many failed authentications from this address (code too_many_failed_authentications). On the catalogue operations, also when the response would take the account beyond the distinct medias it may see per UTC day (code catalogue_daily_cap_reached): details.remaining says how many new medias still fit today, Retry-After is the time to the next UTC midnight, and medias already seen today stay readable. On the managed service requests, also when you sent as many requests of that kind as you may per UTC day (code managed_service_request_limit_reached): Retry-After is the time to the next UTC midnight.

• 500

  An unexpected error (code internal_error).

• 503

  The rate limiter cannot be reached, so the call is refused (code rate_limit_unavailable), or a stored file cannot be read right now (code storage_unavailable). Retry later.

curl -X POST "https://tool.growwer.com/api/v1/seller/orders/$ORDER_ID/deliver" \
  -H "Authorization: Bearer $GROWWER_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com",
  "publicationDateConfirmed": false
}'

{
  "id": "00000000-0000-0000-0000-000000000000",
  "reference": "string",
  "type": "post",
  "state": "string",
  "requiresYourAction": false,
  "availableActions": [
    "accept"
  ],
  "earnings": {
    "amount": 12500,
    "currency": "EUR"
  },
  "project": {
    "url": "string"
  },
  "media": {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "string"
  },
  "createdAt": "2026-01-01T00:00:00+00:00",
  "updatedAt": "2026-01-01T00:00:00+00:00",
  "scheduledPublicationDate": "2026-01-01T00:00:00+00:00",
  "delivery": {
    "url": "string",
    "publishedAt": "2026-01-01T00:00:00+00:00"
  },
  "briefing": {
    "title": "string",
    "language": "string",
    "links": [
      {
        "targetUrl": "string",
        "anchor": "string",
        "type": "dofollow"
      }
    ],
    "extraServices": [
      "list_on_homepage"
    ],
    "additionalInfo": "string",
    "writtenBy": "seller",
    "hasProposedDraft": false
  },
  "draft": {
    "reviewable": false,
    "hasFile": false
  },
  "stateHistory": [
    {
      "state": "string",
      "date": "2026-01-01T00:00:00+00:00",
      "reason": {
        "code": "other_reasons",
        "additionalInfo": "string"
      }
    }
  ],
  "channel": {
    "created": "api",
    "accepted": "api"
  }
}

POST /api/v1/seller/orders/{id}/deliver-draft

Deliver a draft

Delivers the draft of a post order placed on one of your medias whose draft you write (state pending_draft), as the web does, from a file you uploaded with POST /files. The order moves to pending_draft_review when the buyer reviews drafts, otherwise to pending_order_delivery. The file is used up once the draft is delivered; a refused request leaves it usable.

Parámetros