Searching

Most of the endpoints that return a list of API resources support searching. Please visit the API reference to get this information for a specific endpoint. The search can be performed using the q query param, e.g.:

curl --request GET \
--url 'https://api.northpass.com/v2/courses?q=Testing' \
--header 'Accept: application/json' \
--header 'X-Api-Key: <INSERT_API_KEY_HERE>'

The example above will search for the string "Testing" in courses' attributes and return a list of matching courses.

Each endpoint has its own set of attributes that are used for searching. The exact search attributes for each endpoint will be presented in the API reference in the near future.


Did this page help you?