Retrieve your bulk searches

When you launch a bulk search, a file is created by Icypeas. This file allows you to download the results and follow the progression.

tip

This route is paginated. To know how it works, please see here

You need to provide :

• Your user id (see here to understand how to fetch it);
• a limit: number of files in a single request;
• name (optional): allow you to filter the returned files by names;

tip

If you want the last sent file, just set your limit to 1 😉
You can also give the file id you want to retrieve, using the file field. See below

caution

Things you have to keep in mind !

• Maximum limit is 50!
• Files will be ordered by creation date!

POSThttps://app.icypeas.com/api/search-files/read

Get all your bulk searches.

BODY PARAMS

user*(has to be a userId)string

Your account's unique ID.

limit*number

Limit of files to send.

namestring

If you want to filter your search by file names, use this field.

filestring

If you want to get a specifc bulk, please use this field with your file id

status(has to be either 'in_progress' or 'done')string

If you want to fetch only bulk searches that are in progress or that are done

nextboolean

If you want to paginate, use this field. true = next page | false = previous page

sortsarray

Array used to paginate your files, it is this item you need to pass in your requests if you want to paginate further

creationDate*number

I don't know what to write here.

/search-files/read

{
    "user": "#USERID#",
    "limit": 2
}

RESPONSES