Skip to main content
GET
/
api
/
funders
/
Search funders by name
curl --request GET \
  --url https://app.herondata.io/api/funders/ \
  --header 'x-api-key: <api-key>'
[
  {
    "aliases": [
      "<string>"
    ],
    "classification_instructions": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "email_domains": [
      "<string>"
    ],
    "extraction_instructions": "<string>",
    "heron_id": "<string>",
    "last_updated": "2023-11-07T05:31:56Z",
    "logo_url": "<string>",
    "merchant_heron_id": "<string>",
    "name": "<string>",
    "offer_email_instructions": "<string>",
    "offer_portal_instructions": "<string>",
    "slug": "<string>",
    "submission_email_address": "<string>"
  }
]

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
q
string
required

Funder name (or alias) prefix/fuzzy search term.

Minimum string length: 3
​
limit
integer
default:50

Maximum number of matching funders to return (capped server-side).

Required range: 1 <= x <= 50

Response

200 - application/json

Matching funders sorted by similarity descending.

​
aliases
string[]
read-only
​
classification_instructions
string | null
read-only
​
created
string<date-time>
read-only
​
email_domains
string[]
read-only
​
extraction_instructions
string | null
read-only
​
heron_id
string
read-only
​
last_updated
string<date-time>
read-only
​
logo_url
string | null
read-only
​
merchant_heron_id
string
read-only
​
name
string
read-only
​
offer_email_instructions
string | null
read-only
​
offer_portal_instructions
string | null
read-only
​
offer_source
any | null
read-only
Available options:
email,
api,
web_portal,
all_offers,
crm_lendsaas,
null
​
slug
string | null
read-only
​
submission_channel
any | null
read-only
Available options:
email,
api,
web_portal,
all_offers,
crm_lendsaas,
null
​
submission_email_address
string | null
read-only