Warning: If you have not obtained your JWT access_token, please refer to the Authorization section to obtain your token before coming back to this guide.

Type Ahead Autocomplete

Our Type Ahead Autocomplete endpoint allows you to have results returned immediately as someone is searching for a cause.

The list of available parameters when using Autocomplete can be seen in the API Reference page under Autocomplete.

Note: The minimum number of characters need is 3 for any results to be returned.

Sample request:

To search for food or football, your q parameter would start with foo and as more letters are added your results are narrowed down.

Sample response:

{
    "data": [
        {
            "type": "predictions",
            "id": "p124-793876137RR0001",
            "attributes": {
                "term": "Wayne Foo Foundation",
                "reference": "124-793876137RR0001",
                "content_type": "causes"
            }
        },
        {
            "type": "predictions",
            "id": "p840-841791270",
            "attributes": {
                "term": "FOO SOCIETY INC",
                "reference": "840-841791270",
                "content_type": "causes"
            }
        },
        {
            "type": "predictions",
            "id": "p840-832331498",
            "attributes": {
                "term": "STOCKTON FOOD PANTRY INC",
                "reference": "840-832331498",
                "content_type": "causes"
            }
        }
    ]
}

Response Details:

You can then use the attributes->term (name of the cause) to display back to users and the attribute->reference (Benevity ID of the cause) to go directly to the cause using our Get Cause Details endpoint.

🚀 ☀️ ⭐️ Congratulations! ⭐️ ☀️ 🚀

You have now found a cause worthy of your support, and you can begin engaging your users by enabling them to make a donation.