List directories

GET

https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/

Return the list of directory details information belonging to the logged-in user organization

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Responses

🟢200OK

application/json

Successful operation

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/' \
--header 'Authorization: <api-key>'

Response Example

[
    [
        {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "href": "/api/directory/private/v1alpha/directories/3fa85f64-5717-4562-b3fc-2c963f66afa6/",
            "name": "Acme Directory",
            "organization": {
                "name": "Acme Inc."
            },
            "settings": {
                "customUrl": "https://acme.com/directory/",
                "featuredEntriesEnabled": false,
                "filterMappingsEnabled": false,
                "i18nDynamicContentTranslationEnabled": null,
                "entryTypes": [
                    "app",
                    "partner"
                ],
                "entryTypeSettings": {
                    "app": {
                        "urlSegment": "app",
                        "onCardClick": "details"
                    },
                    "partner": {
                        "urlSegment": "partner"
                    }
                }
            },
            "customizations": {
                "logo": "https://cdn.partnerpage.io/media/logos/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo.png",
                "favicon": "https://cdn.partnerpage.io/media/favicons/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo.png",
                "interactiveColor": "#FFFFFF",
                "actionPrimaryColor": "#AAAAAA",
                "colorsTheme": {
                    "bgSurface": "#ffffff",
                    "bgSurfaceSecondary": "#f7f7f7",
                    "bgFill": "#ffffff",
                    "bgFillHover": "#fafafa",
                    "bgFillActive": "#f7f7f7",
                    "bgFillDisabled": "#f5f5f5",
                    "bgFillTertiary": "#e5e5e5",
                    "bgFillTertiaryHover": "#e0e0e0",
                    "bgFillTertiaryActive": "#dbdbdb",
                    "bgFillBrand": "#537397",
                    "bgFillBrandHover": "#758fac",
                    "bgFillBrandActive": "#8fa4bb",
                    "text": "#303030",
                    "textEmphasis": "#303030",
                    "textSecondary": "#616161",
                    "textDisabled": "#b5b5b5",
                    "textLink": "#005bd3",
                    "textLinkHover": "#004299",
                    "textLinkActive": "#002e6a",
                    "textBrand": "#537397",
                    "textBrandOnBgFill": "#ffffff",
                    "textBrandOnBgFillHover": "#ffffff",
                    "textBrandOnBgFillActive": "#ffffff",
                    "border": "#e3e3e3",
                    "borderSecondary": "#ebebeb",
                    "icon": "#4a4a4a",
                    "iconBrand": "#537397",
                    "inputBgSurface": "#fdfdfd",
                    "inputBgSurfaceHover": "#fafafa",
                    "inputBgSurfaceActive": "#f7f7f7",
                    "inputBorder": "#8a8a8a",
                    "inputBorderHover": "#616161",
                    "inputBorderActive": "#1a1a1a"
                },
                "cssFile": "https://cdn.partnerpage.io/media/css/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom.css",
                "custom_navbar": {
                    "name": "SectionCommonCode",
                    "settings": {
                        "html": "<nav>NEW NAVBAR</nav>",
                        "slotMeta": {
                            "fixed": false,
                            "fixedHeight": null
                        }
                    }
                },
                "directory_featured_section": {
                    "title": "Featured partners"
                },
                "directory_main_section": {
                    "title": "Find partners"
                },
                "custom_footer": {
                    "name": "SectionCommonCode",
                    "settings": {
                        "html": "<div>FOOTER</div>"
                    }
                },
                "custom_first_section": {
                    "name": "SectionCommonCode",
                    "settings": {
                        "html": "<section>FIRST SECTION</section>"
                    }
                },
                "custom_second_section": {
                    "name": "SectionCommonCode",
                    "settings": {
                        "html": "<section>SECOND SECTION</section>"
                    }
                },
                "custom_last_section": {
                    "name": "SectionCommonCode",
                    "settings": {
                        "html": "<section>LAST SECTION</section>"
                    }
                }
            },
            "tracking": {
                "umamiWebsiteId": "b2064f90-5fbd-427a-a7d3-d1e47b4a1900",
                "umamuShareId": "ChX32kmasdf"
            },
            "seo": {
                "metaTitle": "Acme Inc. Directory",
                "metaDescription": "Discover Acme Inc. partners and apps.",
                "metaImage": "https://cdn.partnerpage.io/media/logos/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo.png",
                "indexDirectory": true,
                "siteName": "Acme Inc."
            }
        }
    ]
]

Modified at 2026-04-24 18:08:20

Update the settings for a directory

Get a directory