Skip to navigation

Search Sources

Searches the sources visible to your organization by name: the canonical sources Chariot maintains, plus any custom sources your organization has added. Results are ranked by match, best first. This endpoint exists to support a typeahead or a quick lookup when you know a source’s name. Use List Sources to page the full catalog.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

qstringRequired
The text to search source names for. This is a fuzzy search on the source name.
scopeenumOptional
Filter by source scope. Omit to return both canonical and custom sources.
Allowed values:
limitintegerOptional

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

page_tokenstringOptional
The cursor to use for pagination. If not set, the first page of results will be returned.

Response headers

X-Request-IdstringOptional
The unique identifier for the request

Response

The response for Sources.search
resultslist of objectsOptional
The matching sources, ranked best first.
next_page_tokenstringOptional

A cursor token to retrieve the next page of results. If specified, more results exist on the server; otherwise the list has been exhausted.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error