Skip to navigation
DirectoryPublic directory

List and search a directory's partners

View as Markdown

Lists the partners and apps a directory shows to its visitors, the same reads the directory’s own pages use. No API key is needed.

Which listings come back: without search or filters, only public listings. Once either is set, searchable listings are included too. hidden and inactive listings are never returned.

Add include=filter_options to also get each listing’s status and assignedFilterOptions, so a site can show and filter partner cards without one details request per partner. With page_size=120, a directory of up to 120 listings comes back in one request; larger directories page with next.

Replace DIRECTORY_ID with your directory’s ID in this minimal request:

curl 'https://v1.api.partnerpage.io/api/search/v1alpha/directories/DIRECTORY_ID/entries/?entry_type=partner&include=filter_options&page_size=120'

Omit optional parameters you do not use. Empty include, ordering or page_size values are invalid; an empty page returns 404.

Results can trail an edit by a few seconds. The partner details endpoint always reads the latest approved profile.

To page through ordering=random, follow the next links or pass a seed. Without one, every request gets a fresh shuffle. An unknown directory returns an empty list.

Path parameters

directoryIdstringRequiredformat: "uuid"
ID of the directory

Query parameters

availabilitybooleanOptional

true (or 1): only partners marked available. Apps have no availability and stay in the results. Blank is ignored; a value other than true, 1 or false is a 400.

entry_typeenumOptional

Only partners, or only apps. Lookup suffixes such as entry_type__in are not supported and are ignored.

Allowed values:
featuredbooleanOptional

true or false: only featured, or only not featured, listings. Blank is ignored; any other value is a 400.

filtersstringOptional

Filter option slugs in brackets, from the filters endpoint. A listing must match every bracket and any slug inside one: (cross-industry,education)(global) returns listings with cross-industry or education, and global. Includes searchable listings. A malformed value is a 400 with {"error": "Filter query parameter is incorrect"}.

includeenumOptional

filter_options adds status and assignedFilterOptions to every listing. Any other value, or an empty one, is a 400.

Allowed values:
orderingenumOptional
Sort order. Without one, a search sorts by relevance. Empty or unknown values return a 400 naming ordering. Repeat the parameter to supply more than one sort value.
pageintegerOptional

Page number, starting at 1. Empty, non-numeric and out-of-range values return 404. Follow next to page through the results.

page_sizeintegerOptional

Listings per page: a positive integer, 5 by default, at most 120. A larger value returns the maximum.

searchstringOptional
Words to look for in names, headlines, descriptions, keywords, tier names and filter option names. Includes searchable listings.
seedstringOptional

A non-empty string keeps ordering=random the same across pages. Missing or blank generates a fresh shuffle.

Response

One page of listings
countinteger
resultslist of objects
nextstring or nullOptionalformat: "uri"
previousstring or nullOptionalformat: "uri"
facetsobjectOptional

Not used by the listing; always empty.

Errors

400
Bad Request Error
404
Not Found Error