API search/get multiple rows in a sheet

Odyssey Medical · 02/08/22

I need some help formulating an API call to retrieve multiple rows of data in a sheet that have a specific key word.

I can successfully use the /2.0/search/sheets/xxxxxx?query="A2" query to get a list of rows however I don't know how to continue this query to then pull all the rows of data that match the query.

Genevieve P. · 02/16/22

Hi @Odyssey Medical

Does your source sheet have a filter on it that matches the value you're looking for? If so, you could use a Get Sheet request and apply this filter as a parameter:

GET /sheets/{id}?filterId={filterId}&exclude=filteredOutRows

Here's the documentation on this: Get Sheet

Cheers,

Genevieve

chris Perry · 04/07/22

Can anyone actually confirm that the above ?filterid={filterId} works?

we cannot get this work. the filter id never changes in the response.

we have noticed that if you change filters in the smartsheet website, then the filter ID changes in the response.

ILKER · 05/11/22

https://community.smartsheet.com/discussion/comment/325349#Comment_325349

....?filterid={ID}&exclude=filteredOutRows didn't help me either could you find a way?

MikeG_O · 07/06/22

I have been trying to figure this out with the python API and discovered in addition to the exclude="filteredOutRows" parameter the sequence of your options are key.

The API code wants the filter_id last. So using something like this works.

t = smartAPI.Sheets.get_sheet(

9905399599899399, # sheetId

exclude="filteredOutRows",

filter_id=5758236805621636, # filterId - created in the Smartsheet sheet

)

I tested it in Postman and this same format works.

https://api.smartsheet.com/2.0/sheets/9905399599899399?exclude=filteredOutRows&filterId=5758236805621636

API search/get multiple rows in a sheet

Answers

Categories