Search external sources

get

https://api.talkdeskapp.com/knowledge-management/external-sources

Searches the list of external sources according to the specified filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

km-external-sources:read

Query Params

page

integer

1 to 10737419

Defaults to 1

The requested page.

per_page

integer

1 to 200

Defaults to 50

The maximum amount of items to be returned per page.

query_by_name

string

length between 0 and 2147483647

The search query used to filter the external sources name.

metadata

array of strings

One or more key-value pairs in the form of key:value to filter external sources by their metadata. The :value part is optional. If omitted, the server will search for external sources where the value for the specified metadata key is null or undefined.

metadata

connector_type

array of strings

Filter external sources by their connector type. Accepts multiple values to filter by more than one connector type.

connector_type

Allowed:

status

array of strings

Filter external sources by their current indexing status. Accepts multiple values to filter by more than one status.

status

Allowed:

last_sync_after

date-time

length between 20 and 30

Return only external sources whose last sync ended at or after this timestamp. Must be a valid ISO 8601 date-time string (e.g. 2024-01-15T10:00:00.000Z).

last_sync_before

date-time

length between 20 and 30

Return only external sources whose last sync ended at or before this timestamp. Must be a valid ISO 8601 date-time string (e.g. 2024-01-15T23:59:59.000Z).

order_by

string

length between 1 and 200

Comma-separated list of sort specifications in the form field:direction.

Supported sort fields:

name - Sort by external source name
status - Sort by indexing status
last_sync - Sort by the date of the last completed sync

Supported directions: asc, desc. Multiple fields can be combined.
Defaults to name:asc when omitted.

Examples:

order_by=name:asc - Sort by name ascending
order_by=last_sync:desc - Sort by last sync date descending
order_by=name:asc,status:desc - Sort by name then status

Responses

Scope

200List of external sources.

400Bad Request.

401Unauthorized access - invalid or unverifiable JWT.

403Forbidden access - can't find the required scope in the JWT.

500Internal Server Error.