For the complete documentation index, see llms.txt. This page is also available as Markdown.

Free Recommendations

Free Recommendations

The free-recommendations directory: the Partner Network catalog of newsletters this publication can recommend for free, plus the two actions taken from it — recommend one, or request a partnership (ask them to recommend you back).

Browse the directory

GET https://api.sparkloop.app/v3/publications/:publication_uuid/grow/directory/free_recommendations

Paginated. Returns active newsletters opted into the directory, excluding this publication and any it has archived.

Path Parameters

Name
Type
Description

publication_uuid*

String

The publication a recommendation would be attributed to.

Query Parameters

Name
Type
Description

q

String

Free-text search.

categories

String

Comma-separated category names (matched case-insensitively).

language

String

Filter by language.

{
  "recommendations": [
    <Free Recommendation Object>
  ],
  "meta": {
    "per_page": 50,
    "page": 1,
    "total_pages": 20,
    "total_recommendations": 964
  }
}

Get a directory entry

GET https://api.sparkloop.app/v3/publications/:publication_uuid/grow/directory/free_recommendations/:uuid

On a single entry the object also carries the per-caller already_recommended and partnership_request_pending flags.

Path Parameters

Name
Type
Description

publication_uuid*

String

The viewing publication's UUID.

uuid*

String

The directory publication's UUID.

Add a free recommendation

POST https://api.sparkloop.app/v3/publications/:publication_uuid/grow/directory/free_recommendations/:free_recommendation_uuid/recommend

Starts recommending the target publication for free. Returns the created Recommendation.

Path Parameters

Name
Type
Description

publication_uuid*

String

The recommending publication's UUID.

free_recommendation_uuid*

String

The directory publication's UUID.

Request a partnership

POST https://api.sparkloop.app/v3/publications/:publication_uuid/grow/directory/free_recommendations/:free_recommendation_uuid/partnership_request

Asks the target publication to recommend this one back.

Path Parameters

Name
Type
Description

publication_uuid*

String

The requesting publication's UUID.

free_recommendation_uuid*

String

The invited publication's UUID.