Employee Data
...
Elasticsearch DSL
Pagination
15 min
learn how to use pagination in employee posts api https //api coresignal com/cdapi /v2/post employee/search/es dsl endpoint shortcuts pagination /#using p agination in swagger ui examples of pagination usage in swagger ui pagination /#using p agination in curl requests examples of pagination usage with curl requests overview why is pagination needed? profile ids are provided in batches of 1000 ids per page sometimes, a request might yield more ids than can be displayed on a single page in such situations, you'll need to use pagination to obtain all the requested ids from the post request where can i see the page count? response headers in swagger ui navigate to the responses section and locate the response headers respose header infomation response headers contain information such as the total result count , page number , and the last id on the page example x next page after "2025 02 21t00 00 00 000z",7298786868853161984 x total pages 29 x total results 28056 x next page after displays the last id on the page x total pages lists the total number of pages with id results x total results shows the total number of ids returned by your search using p agination in swagger ui pagination without sorting use parameter x next page after to retrieve the second page of ids 1\ navigate to the response headers in the responses section and see the following result example x next page after "2025 02 21t00 00 00 000z",7298786868853161984 x total pages 29 x total results 28056 2\ copy the numeric value in the x next page after parameter ( "2025 02 21t00 00 00 000z",7298786868853161984 ) 3\ i nput the value in the after field in the parameters section 4\ press execute , and you will see the next page in the response body pagination using sorting pagination using id sorting works the same way as pagination without sorting pagination using score sorting has a different id format the format difference is seen by the x next page after parameter the number preceding the comma is for the score , and the one after the score is the last id on the page sorting by score x next page after 11 875278,"2024 09 03t00 00 00 000z",7236756071086710784 x total pages 29 x total results 28056 pagination usage example (swagger ui) retrieve the last id of the page ( 11 875278,"2024 09 03t00 00 00 000z",7236756071086710784 ) and i nput in the after field under parameters 3 press execute ; you will see the next page in the response body using p agination in curl requests this tutorial requires prior knowledge of compiling and executing post requests in employee posts api elasticsearch dsl endpoint use parameter x next page after to retrieve a second page of ids navigate to the headers section and click it 2\ find the following x next page after , x total pages , and x total results information x next page after displays the last id on the page x total pages lists the total number of pages available for your search x total results shows the total number of ids available 3\ add parameter ?after={last id} to the post request to see the next results page 4\ execute the request, and you will see the next page in the body section \[ 1000, 1001, 3000, 4004 ] pagination using sorting pagination, when sorting by id, works the same way as pagination without sorting pagination usage example (curl request in postman) add parameter ?after={last id} to the post request refer to the example below for the exact parameter placement pagination (sorted by id) curl x 'post' \\ 'https //api coresignal com/cdapi/v2/post employee/search/es dsl?after=6553076922996396032' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "query" { "match" { "author name" { "query" "john smith", "operator" "and" } } }, "sort" \[ "id" ] }' send the request, and you will see the next page in the (response) body pagination using score sorting has a different id format the format difference is seen by the x next page after parameter the number preceding the comma is for the score , and the one after the score is the last id on the page pagination usage example (curl request in postman) add parameter ?after={x next page after} to the post request to see the next results page refer to the example below for the exact parameter placement pagination (sorted by score) curl x 'post' \\ 'https //api coresignal com/cdapi/v2/post employee/search/es dsl?after=11 875278,"2024 09 03t00 00 00 000z",7236756071086710784' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "query" { "match" { "author name" { "query" "john smith", "operator" "and" } } }, "sort" \[ " score" ] }' send the request, and you will see the next page in the (response) body limiting search results per page query parameter ?items per page={int} allows you to specify the number of results retrieved per search results page the current limit is 1,000 thus, this parameter lets you set a smaller limit value for the results page items per page curl x 'post' \\ 'https //api coresignal com/cdapi/v2/post employee/search/es dsl?items per page=150' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "query" { "match" { "author name" { "query" "john smith", "operator" "and" } } } }'