List directories

GET

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

GET

/api/directory/private/v1alpha/directories/

curl https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/ \
     -H "Authorization: Token  <apiKey>"

200application/json example

[
  {
    "0": {
      "customizations": {
        "actionPrimaryColor": "#AAAAAA",
        "colorsTheme": {
          "bgFill": "#ffffff",
          "bgFillActive": "#f7f7f7",
          "bgFillBrand": "#537397",
          "bgFillBrandActive": "#8fa4bb",
          "bgFillBrandHover": "#758fac",
          "bgFillDisabled": "#f5f5f5",
          "bgFillHover": "#fafafa",
          "bgFillTertiary": "#e5e5e5",
          "bgFillTertiaryActive": "#dbdbdb",
          "bgFillTertiaryHover": "#e0e0e0",
          "bgSurface": "#ffffff",
          "bgSurfaceSecondary": "#f7f7f7",
          "border": "#e3e3e3",
          "borderSecondary": "#ebebeb",
          "icon": "#4a4a4a",
          "iconBrand": "#537397",
          "inputBgSurface": "#fdfdfd",
          "inputBgSurfaceActive": "#f7f7f7",
          "inputBgSurfaceHover": "#fafafa",
          "inputBorder": "#8a8a8a",
          "inputBorderHover": "#616161",
          "text": "#303030",
          "textBrand": "#537397",
          "textBrandOnBgFill": "#ffffff",
          "textBrandOnBgFillActive": "#ffffff",
          "textBrandOnBgFillHover": "#ffffff",
          "textDisabled": "#b5b5b5",
          "textEmphasis": "#303030",
          "textLink": "#005bd3",
          "textLinkActive": "#002e6a",
          "textLinkHover": "#004299",
          "textSecondary": "#616161"
        },
        "cssFile": "https://cdn.partnerpage.io/media/css/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom.css",
        "custom_first_section": {
          "name": "SectionCommonCode",
          "settings": {
            "html": "<section>FIRST SECTION</section>"
          }
        },
        "custom_footer": {
          "name": "SectionCommonCode",
          "settings": {
            "html": "<div>FOOTER</div>"
          }
        },
        "custom_last_section": {
          "name": "SectionCommonCode",
          "settings": {
            "html": "<section>LAST SECTION</section>"
          }
        },
        "custom_navbar": {
          "name": "SectionCommonCode",
          "settings": {
            "html": "<nav>NEW NAVBAR</nav>",
            "slotMeta": {
              "fixed": false,
              "fixedHeight": null
            }
          }
        },
        "custom_second_section": {
          "name": "SectionCommonCode",
          "settings": {
            "html": "<section>SECOND SECTION</section>"
          }
        },
        "directory_featured_section": {
          "title": "Featured partners"
        },
        "directory_main_section": {
          "request_link": {
            "button_label": "Ask us",
            "title": "Missing an app?",
            "url": "https://www.example.com/request"
          },
          "search_placeholder": "Search members or keywords",
          "title": "Find partners"
        },
        "favicon": "https://cdn.partnerpage.io/media/favicons/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo.png",
        "faviconUrl": "https://cdn.partnerpage.io/media/favicons/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo.png",
        "interactiveColor": "#FFFFFF",
        "logo": "https://cdn.partnerpage.io/media/logos/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo.png",
        "logoUrl": "https://cdn.partnerpage.io/media/logos/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo.png"
      },
      "href": "/api/directory/private/v1alpha/directories/3fa85f64-5717-4562-b3fc-2c963f66afa6/",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Acme Directory",
      "organization": {
        "name": "Acme Inc."
      },
      "seo": {
        "indexDirectory": true,
        "metaDescription": "Discover Acme Inc. partners and apps.",
        "metaImage": "https://cdn.partnerpage.io/media/logos/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo.png",
        "metaTitle": "Acme Inc. Directory",
        "siteName": "Acme Inc."
      },
      "settings": {
        "customUrl": "https://acme.com/directory/",
        "entryTypeSettings": {
          "app": {
            "onCardClick": "details",
            "urlSegment": "app"
          },
          "partner": {
            "urlSegment": "partner"
          }
        },
        "entryTypes": [
          "app",
          "partner"
        ],
        "featuredEntriesEnabled": false,
        "filterMappingsEnabled": false,
        "i18nDynamicContentTranslationEnabled": null
      },
      "tracking": {
        "umamiWebsiteId": "b2064f90-5fbd-427a-a7d3-d1e47b4a1900",
        "umamuShareId": "ChX32kmasdf"
      }
    },
    "href": "string",
    "id": "string",
    "name": "string",
    "organization": {
      "id": "string",
      "name": "string"
    },
    "settings": {
      "href": "string",
      "genericDirectoryId": "string",
      "customUrl": "string",
      "globalCallToActionUrl": "string",
      "globalCallToActionLabel": "string",
      "contactButtonLabel": "string",
      "featuredEntriesEnabled": true,
      "entryTypes": [
        "app"
      ],
      "entryTypeSettings": {},
      "pageSizeSelectionOnDirectory": true,
      "filterMappingsEnabled": true,
      "badgesEnabled": true,
      "calloutsEnabled": true,
      "customFormsEnabled": true,
      "certificationsEnabled": true,
      "verificationsEnabled": true,
      "callToActionEnabled": true,
      "awardsEnabled": true,
      "availabilityToggleEnabled": true,
      "landingPageEnabled": true,
      "customLandingPagesEnabled": true,
      "partnerPortalEnabled": true,
      "customSlugEnabled": true,
      "darkLogosEnabled": true,
      "partnerCompareEnabled": true,
      "embeddedEditorEnabled": true,
      "keywordsEnabled": true,
      "questionnaireEnabled": true,
      "mediaEnabled": true,
      "caseStudiesEnabled": true,
      "clientsEnabled": true,
      "testimonialsEnabled": true,
      "specialOffersEnabled": true,
      "contactRequestsEnabled": true,
      "dealRegistrationsEnabled": true,
      "partnerSourcedLeadsRequireApproval": true,
      "crmConnectionsEnabled": true,
      "tiersEnabled": true,
      "matchmakingRequestsEnabled": true,
      "matchmakingRequestsPublic": true,
      "partnerApplicationsEnabled": true,
      "getListedEnabled": true,
      "assignMatchmakingRequestEnabled": true,
      "useCasesEnabled": true,
      "accreditationsEnabled": true,
      "externalUrlEnabled": true,
      "externalIdEnabled": true,
      "externalIdUnique": true,
      "partnerWebhooksEnabled": true,
      "partnerApplicationDeclinedEmailEnabled": true,
      "partnerApplicationAcceptanceMessage": "string",
      "showBottomBar": true,
      "legacyPartnerViewEnabled": true,
      "profileSectionOrderingEnabled": true,
      "hostedPagesDisabled": true,
      "profilePreviewUrlTemplate": "string",
      "holdRepeatedRequestsEnabled": true,
      "serviceMarketplaceEnabled": true,
      "recommendedSortEnabled": true,
      "internalDirectoryEnabled": true,
      "defaultSorting": "string",
      "entryApprovalFlowEnabled": true,
      "supportEnabled": true,
      "locationEnabled": true,
      "locationsEnabled": true,
      "contactRequestProjectStatusesEnabled": true,
      "contactDetailsAfterAcceptEnabled": true,
      "partnersInvitationsEnabled": true,
      "lastUpdatedEnabled": true,
      "entryDisclaimerTextEnabled": true,
      "gdprEnabled": true,
      "termsOfServiceUrl": "string",
      "privacyPolicyUrl": "string",
      "integrationDescriptionEnabled": true,
      "partnerEmbedEnabled": true,
      "partnerDescriptionMaxLength": 1,
      "reviewsEnabled": true,
      "autoApproveReviewsEnabled": true,
      "showFullReviewInformationEnabled": true,
      "showDescriptionOnCard": true,
      "i18nEnabled": true,
      "i18nMode": "prefix",
      "i18nLanguages": null,
      "i18nDynamicContentTranslationEnabled": true,
      "partnerFinderEnabled": true,
      "badgesShowWideEnabled": true,
      "crmObjectsEnabled": true,
      "schedulerEnabled": true,
      "schedulerPostCallFeedbackEnabled": true,
      "enrichProfileDirOwnerEnabled": true,
      "enrichProfileEntryOwnerEnabled": true,
      "entryWebsiteLinkEnabled": true,
      "contactRequestsCustomFieldsForm": "string",
      "requireBusinessEmailForLeadForms": true,
      "selfServeSettingsEnabled": true,
      "indexDirectory": true,
      "type": "string",
      "plan": "string",
      "urlCustomizationEnabled": true,
      "webhooksEnabled": true,
      "webhooksSecret": "string",
      "customUrlSetupMethod": "string",
      "customDomainRouterId": "string"
    },
    "customizations": {
      "href": "string",
      "genericDirectoryId": "string",
      "logo": "string",
      "internalLogo": "string",
      "favicon": "string",
      "internalFavicon": "string",
      "logoUrl": "string",
      "internalLogoUrl": "string",
      "faviconUrl": "string",
      "internalFaviconUrl": "string",
      "interactiveColor": "string",
      "actionPrimaryColor": "string"
    },
    "tracking": {
      "umamiWebsiteId": "string",
      "umamiShareId": "string"
    },
    "seo": {
      "indexDirectory": true
    }
  }
]

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

Authentication

AuthorizationToken

Your API key, sent as Authorization: Token <your API key>

Response

Successful operation

hrefstringRead-only

idstringformat: "uuid"

namestring or null<=255 characters

organizationobject

settingsobject

All resources should return their href url

customizationsobject

All resources should return their href url

trackingobject

seoobject