Get a partner's profile by slug

GET

https://v1.api.partnerpage.io/api/directory/public/v1alpha/directories/:directoryId/entries/partners/slugs/:slug/

GET

/api/directory/public/v1alpha/directories/:directoryId/entries/partners/slugs/:slug/

curl https://v1.api.partnerpage.io/api/directory/public/v1alpha/directories/directoryId/entries/partners/slugs/slug/

{
  "href": "/api/directory/public/v1alpha/directories/e2b2a65f-0972-4fb4-96bb-498a63411bb6/entries/partners/slugs/the-best-partner/",
  "id": "237ff0f4-e9d5-4be6-a21a-5c913836d523",
  "title": "The Best Partner",
  "headline": "The partner that you were waiting for.",
  "type": "partner",
  "slug": "the-best-partner",
  "customSlug": null,
  "featured": true,
  "owner": null,
  "icon": "https://image.domain.com/icon.png",
  "image": "https://image.domain.com/partner.png",
  "iconDark": "https://image.domain.com/icon-dark.png",
  "imageDark": "https://image.domain.com/partner-dark.png",
  "callouts": [
    {
      "id": "68c18fe3-9450-44dd-bc57-b332c53ce069",
      "name": "One Callout",
      "textColor": "#635BFF",
      "backgroundColor": "#E8E6FF",
      "order": 0
    }
  ],
  "website": "https://the-best-partner.com/",
  "filters": [
    {
      "id": "bb79b73a-923f-4bc6-8e5e-8fc326e5d789",
      "name": "Filter One"
    }
  ],
  "assignedFilterOptions": [
    {
      "id": "de1f695f-f4f1-4699-8989-246377d14aed",
      "name": "option-2",
      "order": 1,
      "slug": "option-2",
      "image": "https://image.domain.com/award.png",
      "filter": "bb79b73a-923f-4bc6-8e5e-8fc326e5d789",
      "parentOptionId": null,
      "parentOptionSlug": null,
      "hasResults": null
    },
    {
      "id": "91292760-12fa-4858-a6bd-f1dded3905e2",
      "name": "other option",
      "order": 2,
      "slug": "other-option",
      "image": "https://image.domain.com/other-option.png",
      "filter": "bb79b73a-923f-4bc6-8e5e-8fc326e5d789",
      "parentOptionId": null,
      "parentOptionSlug": null,
      "hasResults": null
    }
  ],
  "status": "public",
  "recommendedOrder": null,
  "rating": 1.9,
  "numberOfReviews": 14,
  "numberOfReviewsByRating": null,
  "tier": {
    "title": "Gold",
    "image": null
  },
  "description": "The partner that you were waiting for, no, seriously.",
  "integrationDescription": null,
  "awards": [
    {
      "id": "68c18fe3-9450-44dd-bc57-b332c53ce069",
      "title": "Partner of the year",
      "file": "https://image.domain.com/award.png",
      "order": 0
    }
  ],
  "location": "Ciudad de la Costa, Canelones, Uruguay",
  "callToActionUrl": "https://just.do.it.com/",
  "callToActionResolvedUrl": "https://just.do.it.com/",
  "callToActionLabel": "Call to action Label",
  "externalUrl": "https://external.partner.url.com/",
  "certifications": [
    {
      "id": "b2a0414d-f05d-4f34-a2f3-990116b9cdfd",
      "title": "Certification 3 (order 0)",
      "order": 0,
      "quantity": 14
    },
    {
      "id": "8fb8379e-7049-4bb9-95d4-a3017d235789",
      "title": "Certification 1 (order 1)",
      "order": 1,
      "quantity": 14
    },
    {
      "id": "85929f1d-10e3-459a-8e2d-622ed16d5110",
      "title": "Certification 2 (order 2)",
      "order": 2,
      "quantity": 1
    }
  ],
  "resources": [
    {
      "id": "e4f88344-ec9d-438b-9e05-f2f4cc89ed88",
      "title": "Entry Resource",
      "order": 0,
      "url": "https://partner.domain.com/resource",
      "file": null
    }
  ],
  "specialOffers": [
    {
      "id": "e4f88344-ec9d-438b-9e05-f2f4cc89ed88",
      "title": "Entry Special Offer",
      "order": 0,
      "url": "https://partner.domain.com/special-offer",
      "file": null
    }
  ],
  "clients": [
    {
      "id": "e4f88344-ec9d-438b-9e05-f2f4cc89ed88",
      "title": "Client Entry",
      "order": 0,
      "url": "https://client.domain.com/client-url",
      "file": null
    }
  ],
  "testimonials": [
    {
      "id": "134427f8-d25e-466a-806e-7145523a471e",
      "authorName": "John Doe",
      "position": "Project Manager",
      "companyName": "Company Inc.",
      "testimonialText": "This is a great testimonial",
      "order": 0
    }
  ],
  "useCases": [],
  "accreditations": [],
  "keywords": [],
  "verifications": [
    {
      "id": "5a4045d7-9dbb-49ee-9132-180665dcdc3b",
      "title": "A Verification"
    },
    {
      "id": "ada6a021-e996-4d12-85dd-1d5220f67da4",
      "title": "B Verification"
    }
  ],
  "badges": [
    {
      "id": "2ba1382f-8ea8-4e49-a43f-0caeb9aa92a7",
      "title": "A Badge",
      "image": "https://image.domain.com/app.png",
      "imageUrl": "https://image.domain.com/app.png"
    },
    {
      "id": "f59f8837-67be-4db1-8e5f-852e9465bfb0",
      "title": "B Badge",
      "image": "https://image.domain.com/app.png",
      "imageUrl": "https://image.domain.com/app.png"
    }
  ],
  "media": [
    {
      "id": "6a5fc0f0-c938-4b4e-85c2-b895a90b000d",
      "title": "Media 1",
      "description": "Media 1 description",
      "url": "https://image.domain.com/partner.png",
      "file": "https://image.domain.com/partner.png",
      "order": 0,
      "pdfFileThumbnailUrl": "https://image.domain.com/partner.png",
      "type": "I"
    }
  ],
  "caseStudies": [],
  "locations": [],
  "tracking": {
    "umamiWebsiteId": "ed2faba6-7aec-459a-b997-97fcfc390709"
  },
  "supportEmail": "support@domain.com",
  "developerName": "The Best Partner Developer",
  "availability": null,
  "contactRequestsEnabled": true,
  "metaTitle": "The Best Partner: certified implementation partner",
  "metaDescription": null,
  "modified": "2021-09-01T00:00:00Z",
  "marketplaceSettings": null,
  "embedTitle": null,
  "embedSrc": null,
  "embedHeight": null,
  "profileFields": {
    "projects_delivered": 120,
    "team_size": {
      "key": "size_51_200",
      "label": "51-200 people"
    }
  },
  "mainAreaFilters": [
    {
      "id": "0e3c1b1e-7a1a-4b2c-9f3d-2a6e1c9b7d10",
      "name": "Marketplace Integration Features",
      "slug": "marketplace-integration-features",
      "order": 1,
      "filterOptions": [
        {
          "id": "3f1d2c4b-5a6e-4f70-8b91-0c2d3e4f5a6b",
          "name": "Manage Menus",
          "order": 0,
          "slug": "manage-menus",
          "image": null,
          "assigned": true
        },
        {
          "id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
          "name": "Manage Orders",
          "order": 1,
          "slug": "manage-orders",
          "image": null,
          "assigned": false
        }
      ]
    }
  ]
}

Returns one partner’s profile, with everything its details page shows: logo (icon), cover image, tier, callouts, media, filters and the filter options it has (assignedFilterOptions), and the directory’s public profile fields it filled in (profileFields, by field key). No API key is needed.

Only public and searchable partners are returned. A hidden or inactive partner answers 404, like an unknown slug. When the directory reviews partner edits, this returns the last approved profile; edits waiting for review are not shown. Use the slug the listing returns: a custom slug replaces the original one.

Path parameters

directoryIdstringRequiredformat: "uuid"

ID of the directory

slugstringRequired

The partner's slug, as the listing returns it

Response

Successful operation

hrefstringRead-only

idstringformat: "uuid"

titlestring<=256 characters

headlinestring or null<=250 characters

typestring<=100 characters

slugstringformat: "^[-a-zA-Z0-9_]+$"<=60 characters

customSlugstring or nullformat: "^[-a-zA-Z0-9_]+$"<=60 characters

featuredboolean

ownermap from strings to any or null

iconstring or null

imagestring or null

iconDarkstring or null

imageDarkstring or null

calloutslist of objects

websitestring or nullformat: "uri"

filterslist of objects

assignedFilterOptionslist of objectsRead-only

statusenum

hidden - hidden
inactive - inactive
public - public
searchable - searchable

Allowed values:

recommendedOrderinteger or null

ratingdouble or null

numberOfReviewsinteger or null

numberOfReviewsByRatingany or null

tierobject or null

descriptionstring or null

integrationDescriptionstring or null

awardslist of objects

locationstring or null<=255 characters

callToActionUrlstring or null

callToActionResolvedUrlstring or null

callToActionLabelstring or null<=25 characters

externalUrlstring or nullformat: "uri"

certificationslist of objectsRead-only

resourceslist of objects

specialOfferslist of objects or null

clientslist of objects or null

testimonialslist of objects or null

useCaseslist of objects or null

accreditationslist of objects or null

keywordslist of objects

verificationslist of objects or null

badgeslist of objects or null

medialist of objects or null

caseStudieslist of objects or null

locationslist of objects or null

trackingobject

supportEmailstring or null<=250 characters

developerNamestring or null<=250 characters

availabilityboolean or null

contactRequestsEnabledboolean

metaTitlestring or null<=70 characters

metaDescriptionstring or null<=160 characters

modifieddatetime or nullRead-only

marketplaceSettingsmap from strings to any or nullRead-only

embedTitlestring or nullOptional

embedSrcstring or nullOptionalformat: "uri"

embedHeightinteger or nullOptional

profileFieldsmap from strings to anyOptional

The directory's own public profile fields that this partner filled in, by field key. Each value's shape follows the field's type.

mainAreaFilterslist of objectsOptional

Errors

404

Not Found Error