Get a directory

GET

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

GET

/api/directory/private/v1alpha/directories/:directoryId/

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

{
  "href": "/api/directory/private/v1alpha/directories/3fa85f64-5717-4562-b3fc-2c963f66afa6/",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Acme Directory",
  "organization": {
    "id": "string",
    "name": "Acme Inc."
  },
  "settings": {
    "href": "string",
    "genericDirectoryId": "string",
    "customUrl": "https://acme.com/directory/",
    "globalCallToActionUrl": "string",
    "globalCallToActionLabel": "string",
    "contactButtonLabel": "string",
    "featuredEntriesEnabled": false,
    "entryTypes": [
      "app",
      "partner"
    ],
    "entryTypeSettings": {
      "app": {
        "urlSegment": "app",
        "onCardClick": "details"
      },
      "partner": {
        "urlSegment": "partner"
      }
    },
    "pageSizeSelectionOnDirectory": true,
    "filterMappingsEnabled": false,
    "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",
    "assign_matchmaking_request_enabled": false,
    "awards_enabled": false,
    "badges_enabled": true,
    "call_to_action_enabled": false,
    "callouts_enabled": false,
    "certifications_enabled": true,
    "clients_enabled": false,
    "contact_details_after_accept_enabled": false,
    "contact_request_project_statuses_enabled": false,
    "contact_requests_enabled": false,
    "custom_forms_enabled": false,
    "custom_landing_pages_enabled": false,
    "custom_slug_enabled": false,
    "dark_logos_enabled": false,
    "default_sorting": "random",
    "embedded_editor_enabled": false,
    "entry_approval_flow_enabled": false,
    "entry_disclaimer_text": "",
    "entry_disclaimer_text_enabled": "",
    "external_url_enabled": false,
    "filter_mappings_enabled": false,
    "get_listed_enabled": true,
    "hosted_pages_disabled": false,
    "i18n_dynamic_content_translation_enabled": null,
    "integration_description_enabled": false,
    "internal_directory_enabled": false,
    "keywords_enabled": false,
    "last_updated_enabled": false,
    "location_enabled": false,
    "matchmaking_requests_enabled": false,
    "matchmaking_requests_public": false,
    "media_enabled": false,
    "page_size_selection_on_directory": true,
    "partner_applications_enabled": true,
    "partner_compare_enabled": false,
    "partner_embed_enabled": false,
    "partners_invitations_enabled": true,
    "profile_preview_url_template": "",
    "profile_section_ordering_enabled": false,
    "questionnaire_enabled": false,
    "recommended_sort_enabled": false,
    "show_bottom_bar": true,
    "special_offers_enabled": false,
    "support_enabled": false,
    "testimonials_enabled": false,
    "tiers_enabled": false,
    "use_cases_enabled": false,
    "verifications_enabled": false
  },
  "customizations": {
    "href": "string",
    "genericDirectoryId": "string",
    "logo": "https://cdn.partnerpage.io/media/logos/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo.png",
    "internalLogo": "string",
    "favicon": "https://cdn.partnerpage.io/media/favicons/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo.png",
    "internalFavicon": "string",
    "logoUrl": "https://cdn.partnerpage.io/media/logos/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo.png",
    "internalLogoUrl": "string",
    "faviconUrl": "https://cdn.partnerpage.io/media/favicons/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo.png",
    "internalFaviconUrl": "string",
    "interactiveColor": "#FFFFFF",
    "actionPrimaryColor": "#AAAAAA",
    "colorsTheme": null,
    "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"
    }
  },
  "tracking": {
    "umamiWebsiteId": "b2064f90-5fbd-427a-a7d3-d1e47b4a1900",
    "umamiShareId": "string",
    "umamuShareId": "ChX32kmasdf"
  },
  "seo": {
    "indexDirectory": true,
    "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",
    "siteName": "Acme Inc."
  }
}

Return the detail information of a directory

Authentication

AuthorizationToken

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

Path parameters

directoryIdstringRequiredformat: "uuid"

id of the directory to retrieve

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

Errors

404

Not Found Error