Get a partner's internal directory profile by slug

GET

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

GET

/api/directory/private/v1alpha/directories/:directoryId/entries/partners/internal_details/slugs/:slug/

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

{
  "href": "/api/directory/private/v1alpha/directories/e2b2a65f-0972-4fb4-96bb-498a63411bb6/entries/partners/237ff0f4-e9d5-4be6-a21a-5c913836d523/",
  "id": "237ff0f4-e9d5-4be6-a21a-5c913836d523",
  "title": "The Best Partner",
  "headline": "The App headline.",
  "type": "string",
  "slug": "the-best-partner",
  "customSlug": "string",
  "status": "public",
  "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",
  "website": "https://the.partner.website.com",
  "featured": true,
  "owner": "7f80323b-dc05-4002-a2a0-89c627c2dc82",
  "userAssignedFilterOptions": "string",
  "systemAssignedFilterOptions": "string",
  "mappedAssignedFilterOptions": "string",
  "description": "The partner that you were waiting for!",
  "location": "Dublin, Dublin, Ireland",
  "callToActionUrl": "string",
  "callToActionLabel": "string",
  "externalUrl": "string",
  "resources": [
    {
      "id": "e4f88344-ec9d-438b-9e05-f2f4cc89ed88",
      "title": "Entry Resource",
      "file": null,
      "fileUrl": null,
      "url": "https://partner.domain.com/resource",
      "order": 0
    }
  ],
  "awards": [
    {
      "title": "string",
      "file": "string",
      "order": 1,
      "id": "string"
    }
  ],
  "media": [
    {
      "id": "6a5fc0f0-c938-4b4e-85c2-b895a90b000d",
      "title": "Media 1",
      "description": "Media 1 description",
      "order": 0,
      "pdfFileThumbnailUrl": "https://image.domain.com/partner.png",
      "url": "https://image.domain.com/partner.png",
      "file": "string",
      "type": "I"
    }
  ],
  "supportEmail": "string",
  "developerName": "string",
  "internalMedia": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "order": 1,
      "pdfFileThumbnailUrl": "string",
      "url": "string",
      "file": "string",
      "type": "string"
    }
  ],
  "internalResources": [
    {
      "id": "string"
    }
  ],
  "internalUseCases": [
    {
      "id": "string"
    }
  ],
  "internalTestimonials": [
    {
      "authorName": "string",
      "position": "string",
      "companyName": "string",
      "testimonialText": "string",
      "id": "string"
    }
  ],
  "internalLogos": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "order": 1,
      "pdfFileThumbnailUrl": "string",
      "file": "string",
      "type": "string"
    }
  ],
  "assignedFilterOptions": "string",
  "clients": [
    {
      "id": "e4f88344-ec9d-438b-9e05-f2f4cc89ed88",
      "title": "Client Entry",
      "file": null,
      "fileUrl": null,
      "url": "https://client.domain.com/client",
      "order": 0
    }
  ],
  "certifications": "string",
  "industryCertifications": "string",
  "segmentCertifications": "string",
  "specialOffers": [
    {
      "id": "string"
    }
  ],
  "badges": [
    {
      "href": "string",
      "title": "string",
      "image": "string",
      "id": "string"
    }
  ],
  "locations": [
    {
      "id": "string",
      "title": "string",
      "order": 1,
      "country": 1,
      "countryName": "string",
      "region": 1,
      "regionName": "string",
      "city": 1,
      "cityName": "string"
    }
  ],
  "filters": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "testimonials": [
    {
      "authorName": "string",
      "position": "Project Manager",
      "companyName": "string",
      "testimonialText": "string",
      "id": "134427f8-d25e-466a-806e-7145523a471e",
      "order": 0,
      "author_name": "John Doe",
      "company_name": "Company Inc.",
      "testimonial_text": "This is a great testimonial"
    }
  ],
  "useCases": [
    {
      "id": "string"
    }
  ],
  "verifications": [
    {
      "id": "5a4045d7-9dbb-49ee-9132-180665dcdc3b",
      "title": "A Verification"
    },
    {
      "id": "ada6a021-e996-4d12-85dd-1d5220f67da4",
      "title": "B Verification"
    }
  ],
  "callouts": [
    {
      "href": "string",
      "name": "One Callout",
      "id": "68c18fe3-9450-44dd-bc57-b332c53ce069",
      "order": 0,
      "textColor": "635BFF",
      "backgroundColor": "E8E6FF"
    }
  ],
  "iconUrl": "https://image.domain.com/icon.png",
  "imageUrl": "https://image.domain.com/partner.png",
  "metaTitle": "The Best Partner: certified implementation partner",
  "metaDescription": null,
  "call_to_action_label": "Call to action Label",
  "call_to_action_url": "https://just.do.it.com/",
  "contact_requests_hidden": false,
  "custom_slug": null,
  "developer_name": "The Best Partner Developer",
  "display_on_internal_directory": false,
  "embed_height": null,
  "embed_src": null,
  "embed_title": null,
  "external_url": "https://external.partner.url.com/",
  "internal_channel_contact_cta_label": "Slack us",
  "internal_channel_contact_cta_url": "https://internal.channel.contact.com",
  "internal_description": "Internal description for the partner that you were waiting for!",
  "internal_logos": [
    {
      "description": "Internal Logo 1 description",
      "id": "6166e7e8-e526-4db8-9820-2ca4e5a9d914",
      "order": 0,
      "pdfFileThumbnailUrl": "https://image.domain.com/partner.png",
      "title": "Internal Logo 1",
      "type": "I"
    }
  ],
  "internal_media": [
    {
      "description": "Internal Media 1 description",
      "id": "9513a81e-2bc1-43e1-b446-0750ce3cc1a8",
      "order": 0,
      "pdfFileThumbnailUrl": "https://image.domain.com/partner.png",
      "title": "Internal Media 1",
      "type": "I",
      "url": "https://image.domain.com/partner.png"
    }
  ],
  "internal_point_of_contact_cta_label": "Communicate with us",
  "internal_point_of_contact_cta_url": "https://internal.point.of.contact.com",
  "internal_resources": [
    {
      "file": null,
      "id": "37514dfa-32ff-4d4d-8bda-04978249ad1a",
      "order": 0,
      "title": "Entry Internal Resource",
      "url": "https://partner.domain.com/internal_resource"
    }
  ],
  "internal_testimonials": [
    {
      "author_name": "John Doe",
      "company_name": "Company Inc.",
      "id": "115d89a7-84af-4817-8cbc-ee808650c793",
      "order": 0,
      "position": "Project Manager",
      "testimonial_text": "This is a great internal testimonial"
    }
  ],
  "internal_use_cases": [
    {
      "description": "Use Case 1 description",
      "id": "cbb233e6-de26-4285-89ca-d4c69aa107fb",
      "order": 0,
      "title": "Use Case 1"
    }
  ],
  "metadata": {
    "external_id": "158a0557-8918-4311-bc57-fb5f69c093c1"
  },
  "special_offers": [
    {
      "file": null,
      "fileUrl": null,
      "id": "e4f88344-ec9d-438b-9e05-f2f4cc89ed88",
      "order": 0,
      "title": "Entry Special Offer",
      "url": "https://partner.domain.com/special-offer"
    }
  ],
  "support_email": "support@partner.website.com",
  "tracking": {
    "umami_share_id": "1xdfagJ",
    "umami_website_id": "ed2faba6-7aec-459a-b997-97fcfc390709"
  },
  "use_cases": [
    {
      "description": "Use Case 1 description",
      "id": "aab920e3-a5da-4a59-89d6-44591ddea8ad",
      "order": 0,
      "title": "Use Case 1"
    }
  ]
}

Returns one partner’s profile as the directory’s internal directory shows it to the owner’s employees: internal fields and internal filters, whatever the partner’s status. Needs the directory owner’s API key. For the profile visitors see, use the public partner details endpoint.

Authentication

AuthorizationToken

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

Path parameters

directoryIdstringRequiredformat: "uuid"

id of the directory

slugstringRequired

slug of the entry

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

statusenum

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

Allowed values:

iconstring or null

imagestring or null

iconDarkstring or null

imageDarkstring or null

websitestring or nullformat: "uri"

featuredboolean

ownermap from strings to any or null

userAssignedFilterOptionsstringRead-only

systemAssignedFilterOptionsstringRead-only

mappedAssignedFilterOptionsstringRead-only

descriptionstring or null

locationstring or null<=255 characters

callToActionUrlstring or null

callToActionLabelstring or null<=25 characters

externalUrlstring or nullformat: "uri"

resourceslist of objects

awardslist of objects

medialist of objects or null

supportEmailstring or null<=250 characters

developerNamestring or null<=250 characters

internalMedialist of objects or null

internalResourceslist of objects or null

internalUseCaseslist of objects or null

internalTestimonialslist of objects or null

internalLogoslist of objects or null

assignedFilterOptionsstringRead-only

clientslist of objects or null

certificationsstringRead-only

industryCertificationsstringRead-only

segmentCertificationsstringRead-only

specialOfferslist of objects or null

badgeslist of objects or null

locationslist of objects

filterslist of objects

testimonialslist of objects or null

useCaseslist of objects or null

lastModifiedobject or nullOptional

Serializer for last_modified info including timestamp and user details.

integrationDescriptionstring or nullOptional

internalPointOfContactCtaUrlstring or nullOptional

internalPointOfContactCtaLabelstring or nullOptional<=25 characters

internalChannelContactCtaUrlstring or nullOptional

internalChannelContactCtaLabelstring or nullOptional<=25 characters

availabilityboolean or nullOptional

verificationslist of objects or nullOptional

calloutslist of objectsOptional

keywordslist of objectsOptional

displayOnInternalDirectoryboolean or nullOptional

contactRequestsHiddenbooleanOptional

When on, visitors cannot send this entry a contact request; the directory-wide contact requests setting still applies

internalDescriptionstring or nullOptional

iconUrlstring or nullOptional

imageUrlstring or nullOptional

metaTitlestring or nullOptional<=70 characters

metaDescriptionstring or nullOptional<=160 characters

embedTitlestring or nullOptional

embedSrcstring or nullOptionalformat: "uri"

profileFieldsmap from strings to anyOptional

embedHeightinteger or nullOptional

Errors

404

Not Found Error