Skip to main content

Search with The TypeScript SDK

To try using the IDN search functionality along with pagination, copy this code into your "index.ts" file:

const search = async () => {
let apiConfig = new Configuration()
let api = new SearchApi(apiConfig)
let search: Search = {
indices: [
query: {
query: "*"
sort: ["-name"]
const val = await Paginator.paginateSearchApi(api, search, 100, 1000)

for (const result of {
const castedResult: IdentityDocument = result


Run this command to compile and run the code:

tsc src/index.ts && node src/index.js

This example returns 1000 identities, 100 at a time, and sorts them in descending order by name. You can also change the search pagination by changing "100" and "1000", respectively.

The two main ways you can manipulate this example are to change the indices or the query. For example, if you add "access profiles" to the indices, the SDK will search access profiles too. If you change the query to "a*", the search will return all records starting with the letter "a".

You can also change the sorting logic in the brackets next to sort.