Get Sheet (ID) by Name using Smartsheet API

jokano1

I was wondering if there is a way to get the sheet Id of a specific sheet using the name of the sheet. Get sheet accepts the sheet id to get the sheet info, but I would like to get the sheet using the name. In Bridge, you have the option to get sheet by id or name, so I was wondering if there is a way to get it apart from using Bridge.

Genevieve P.

Hi @jokano1

I would use List Sheets to get a list of all the sheets I have access to (see here), which will bring back the sheet Name and ID. Then loop through to match the Name and get the Sheet ID for your next call.

Cheers,

Genevieve

OptimusPrime

Genevieve P.

Apr 4, 2023

Hi @jokano1

I would use List Sheets to get a list of all the sheets I have access to (see here), which will bring back the sheet Name and ID. Then loop through to match the Name and get the Sheet ID for your next call.

Cheers,

Genevieve

It would be nice to give an example code? the link example is very limited.

Genevieve P.

Hi @OptimusPrime

https://api.smartsheet.com/2.0/sheets

will get you a list of all the sheets that your account has access to. 🙂

OptimusPrime

https://community.smartsheet.com/discussion/comment/432981#Comment_432981

your link shows this….

what is it?

{
"errorCode": 1004,
"message": "You are not authorized to perform this action.",
"refId": "3f8q5g"
}

Genevieve P.

Hi @OptimusPrime

That is not a link to a website, it's an example of the API URL that you can use, for example in Postman, to generate a list of sheets. 🙂 I've updated it so there's no hidden hyperlink which may have caused the confusion.

Here's a link to the API Documentation with more information:

https://smartsheet.redoc.ly/tag/sheets/

OptimusPrime

https://community.smartsheet.com/discussion/comment/432985#Comment_432985

yeah I saw the link. Can you supply a piece of code that get the sheet id from the sheet name? That's the whole point I am asking for a sample code rather than a link.

e.g. How to set a sheet name the PaginationParameters ?

Thank you.

Genevieve P.

Hi @OptimusPrime

I'm not a developer so I won't be the best person to help write any code; I would suggest posting in a developer forum such as StackOverflow if you would like help creating API calls.

I will say, thinking about this again, you can likely use Search Everything instead, with your key phrase as the query and then the scope being "sheetNames" if that's easier:

https://smartsheet.redoc.ly/tag/search#operation/list-search

OptimusPrime

https://community.smartsheet.com/discussion/comment/433027#Comment_433027

Thanks. Do you have a developer in Smartsheet community to support users? just curious.

Genevieve P.

Hi @OptimusPrime

The Community is primarily a member-to-member space to ask questions, share best practices, and chat about Smartsheet with other users (versus Smartsheet staff - although we do pop in to help).

It's very likely that there are other members who are developers that may be able to give you the support you're looking for! Although I would note that the StackOverflow community linked above may be a better space for that, as it's built specifically for developers.

If you're looking for someone to create solutions on your behalf, you could post in the Community Job Board area as there are a number of consultants here in the forum that may be a good fit. You could also contact Smartsheet's Consulting Team, here if that helps!

As a side note, did the Search Everything work better for your purposes?

Cheers,
Genevieve

OptimusPrime

https://community.smartsheet.com/discussion/comment/433042#Comment_433042

Got it. Thanks.