# Accessing Page Information via API

**URL:** <https://community.shotgridsoftware.com/t/accessing-page-information-via-api/19798>\
**Category:** Flow Production Tracking\
**Tags:** python-api\
**Created:** [February 3, 2025, 1:55pm UTC](https://community.shotgridsoftware.com/t/accessing-page-information-via-api/19798 "2025-02-03T13:55:35Z")\
**Posts on this page:** 8\
**Page:** 1

<div class="post-metadata">

**Author:** ![patrickwolf](https://sea1.discourse-cdn.com/shotgunsoftware/user_avatar/community.shotgridsoftware.com/patrickwolf/32/3931_2.png) [@patrickwolf](https://community.shotgridsoftware.com/u/patrickwolf)\
**Post date:** [February 3, 2025, 1:55pm UTC](https://community.shotgridsoftware.com/t/accessing-page-information-via-api/19798/1 "2025-02-03T13:55:35Z")

</div>

Is it possible to access page info via the API?

- Page Name
- Default Tab
- Fields
- Display Names
- Sorting
- Grouping
- etc.

Even if not all of those are some of those accessible?

From the page entity in shotgun itself it looks like none of those things are exposed in the Page Entity

 ![image](https://global.discourse-cdn.com/shotgunsoftware/original/2X/a/aa4069bba39eea26c3dc19392298c5b07f30d38e.png)

Thanks,  
Patrick

---

<div class="post-metadata">

**Author:** ![Ricardo\_Musch](https://sea1.discourse-cdn.com/shotgunsoftware/user_avatar/community.shotgridsoftware.com/ricardo_musch/32/405_2.png) [@Ricardo\_Musch](https://community.shotgridsoftware.com/u/Ricardo_Musch)\
**Post date:** [February 3, 2025, 7:55pm UTC](https://community.shotgridsoftware.com/t/accessing-page-information-via-api/19798/2 "2025-02-03T19:55:33Z")

</div>

I dont know about all that but a Page is an entity so you can definitely query pages and it’s fields through the API.

The grouping etc may be possible via an AMI?

---

<div class="post-metadata">

**Author:** ![patrickwolf](https://sea1.discourse-cdn.com/shotgunsoftware/user_avatar/community.shotgridsoftware.com/patrickwolf/32/3931_2.png) [@patrickwolf](https://community.shotgridsoftware.com/u/patrickwolf)\
**Post date:** [February 3, 2025, 8:37pm UTC](https://community.shotgridsoftware.com/t/accessing-page-information-via-api/19798/3 "2025-02-03T20:37:58Z")

</div>

> [@Ricardo\_Musch](#):
>
> query pages and it’s fields through the API

see the screenshot above. the page entity does not expose fields, sorting, grouping, field names etc. (ie its not possible to see those things when you open the page entity in shotgun).

there is also no field that contains a JSON representation of the page details.

so based on what i see in shotgun its not possible but I’m hopeful someone might have some API ninja tricks that are not easily visible

---

<div class="post-metadata">

**Author:** ![Ricardo\_Musch](https://sea1.discourse-cdn.com/shotgunsoftware/user_avatar/community.shotgridsoftware.com/ricardo_musch/32/405_2.png) [@Ricardo\_Musch](https://community.shotgridsoftware.com/u/Ricardo_Musch)\
**Post date:** [February 3, 2025, 8:44pm UTC](https://community.shotgridsoftware.com/t/accessing-page-information-via-api/19798/4 "2025-02-03T20:44:32Z")

</div>

Try the Fields Admin page, it displays way more fields that are not usually visible in the main UI as they are backend fields.

Some of these things, as I mentioned, are available when you run an AMI from the page.  
For example, which fields are visible on the page, what you have selected etc.

---

<div class="post-metadata">

**Author:** ![patrickwolf](https://sea1.discourse-cdn.com/shotgunsoftware/user_avatar/community.shotgridsoftware.com/patrickwolf/32/3931_2.png) [@patrickwolf](https://community.shotgridsoftware.com/u/patrickwolf)\
**Post date:** [February 4, 2025, 2:18pm UTC](https://community.shotgridsoftware.com/t/accessing-page-information-via-api/19798/5 "2025-02-04T14:18:45Z")

</div>

> [@Ricardo\_Musch](#):
>
> Some of these things, as I mentioned, are available when you run an AMI from the page.  
> For example, which fields are visible on the page, what you have selected etc.

Thanks that might be an alternative way of working with it since the API does not seem to provide the details

---

<div class="post-metadata">

**Author:** ![pixelconductor](https://sea1.discourse-cdn.com/shotgunsoftware/user_avatar/community.shotgridsoftware.com/pixelconductor/32/508_2.png) [@pixelconductor](https://community.shotgridsoftware.com/u/pixelconductor)\
**Post date:** [February 4, 2025, 3:30pm UTC](https://community.shotgridsoftware.com/t/accessing-page-information-via-api/19798/6 "2025-02-04T15:30:46Z")

</div>

Hey Patrick,  
long time no see - hope you are doing well 😀

I guess the **PageSetting** entity is what you are looking for:

> page\_id = 11963  
> setting\_entity = sg.find\_one(‘PageSetting’, [[‘page.Page.id’, ‘is’, page\_id]], [‘settings\_json’])  
> settings = setting\_entity[‘settings\_json’]

Hope that helps.

All the best,  
Tobi (Pfeiffer)

---

<div class="post-metadata">

**Author:** ![Ricardo\_Musch](https://sea1.discourse-cdn.com/shotgunsoftware/user_avatar/community.shotgridsoftware.com/ricardo_musch/32/405_2.png) [@Ricardo\_Musch](https://community.shotgridsoftware.com/u/Ricardo_Musch)\
**Post date:** [February 6, 2025, 8:53pm UTC](https://community.shotgridsoftware.com/t/accessing-page-information-via-api/19798/7 "2025-02-06T20:53:25Z")

</div>

Also a users individual page settings (like filters) may be saved on a hidden field somewhere on their user perhaps.

For example, each user has a hidden field that records if they have gone through the first user login tutorial. There may be a lot you can query that is not part of official docs but still queryable.

---

<div class="post-metadata">

**Author:** ![patrickwolf](https://sea1.discourse-cdn.com/shotgunsoftware/user_avatar/community.shotgridsoftware.com/patrickwolf/32/3931_2.png) [@patrickwolf](https://community.shotgridsoftware.com/u/patrickwolf)\
**Post date:** [April 29, 2025, 2:48am UTC](https://community.shotgridsoftware.com/t/accessing-page-information-via-api/19798/8 "2025-04-29T02:48:30Z")

</div>

> [@pixelconductor](#):
>
> I guess the **PageSetting** entity is what you are looking for:

Hey Tobi, nice to hear from you and yes I was looing for the PageSettings 🙂 and I actually found a great library that uses it along the way

> [@Get all Entities given a Page ID](https://community.shotgridsoftware.com/t/get-all-entities-given-a-page-id/19727/1):
>
> I [created a library, fpt-api](https://pypi.org/project/fpt-api/) first to get an Entity’s query fields, but since I also needed to get all Entities from a Page given its ID, applying the page filters, I also added this functionality.
> 
> It’s a simple method, fpt.yield\_page\_entities, that will fetch all the Entities from a Page. You can optionally add additional filters and overwrite the fields to fetch (by default, the Page’s fields).
