PartnerPage API
  1. Partner Entry
PartnerPage API
  • Introduction
  • Authentication
  • Object Overview
  • Directory
    • Branding
      • Retrieve a directory's branding
      • Update a directory's branding
    • Forms
      • List all custom forms
      • Retrieve the default contact request form
      • Retrieve the currently active contact request form for the specified directory
      • Get all currency field options
      • Create and configure a new custom contact request form for the specified directory
      • Reset the current custom contact request form for the directory to the global default version
    • Callouts
      • Return the list of callouts details information belonging to a directory
      • Return the details of a callout
      • Create a new callout
      • Update a directory callout
      • Update a directory callout
    • Badges
      • Create a directory badge
      • Return the details of a badge
      • Update a directory badge
      • Delete a directory badge
      • Return the list of badge details information belonging to a directory
    • Certifications
      • Return the list of certifications belonging to a directory
      • Create a directory certification
      • Return a certificacion details
      • Update a directory certification
      • Delete a directory certification
    • Filters
      • Retrieve a list of filters within a directory
      • Create a filter within a directory
      • Retrieve a list of filters within a directory
      • Retrieve a list of filters for an external directory
      • Retrieve details of a single filter within a directory
      • Update a filter
      • Deletes a directory filter
      • Retrieve a list of filter options within a filter
      • Create a filter option within a custom filter
      • Deletes a directory filter option
      • Update a custom filter option
      • Retrieve details of a single filter option within a filter in a directory
    • Filter Maps
      • Delete a filter option mapping
      • Update a filter option mapping
      • Retrieve details of a single filter option mapping
      • Retrieve a list of filter option mappings within a directory
      • Create a new filter option mapping
      • Retrieve a list of filter option mappings within a directory
    • Matchmaking
      • Retrieve a list of matchmaking requests for a specific directory
    • Tiers
      • Return the list of tiers belonging to a directory
      • Create a directory tier
      • Return the details of a tier
      • Update a directory tier
      • Delete a directory tier
      • Return the list of entries assigned to an specific tier
      • Assign or Unassign entries to an specific tier
    • Verifications
      • Return the list of verification details information belonging to a directory
      • Create a directory verification
      • Return the details of a verification
      • Update a directory verification
      • Delete a directory verification
    • Return the list of directories
      GET
    • Return the list of directory details information belonging to the logged-in user organization
      GET
    • Return the detail information of a directory
      GET
    • Update generic directory details
      PATCH
    • Update the settings for a specific directory
      PATCH
    • Retrieve the settings for a specific directory
      GET
    • Return the detailed information of a directory you own
      GET
    • Retrieve detailed information about an external directory in which the user's organization has an entry
      GET
  • Entry
    • App Entry
      • Callouts
        • Return the list of app entry callouts
        • Create a new app entry callout
        • Return the details of an app entry callout
        • Update an app entry callout
        • Delete an app entry callout
      • Create new app entry
      • Returns details of an App entry from a directory
      • Update app entry
      • Delete a app entry
      • Update the recommended order of an app entry
    • Partner Entry
      • Badges
        • Return the list of partner entry badges
        • Create a new partner entry badge
        • Return the details of a partner entry badge
        • Update a partner entry badge
        • Delete a partner entry badge
      • Callouts
        • Return the list of partner entry callouts
        • Create a new partner entry callout
        • Return the details of a partner entry callout
        • Update a partner entry callout
        • Delete a partner entry callout
      • Certifications (General)
        • Return the partner entry certifications
        • Create a new partner entry certification
        • Return the details of a partner entry certification
        • Update a partner entry certification
        • Delete a partner entry certification
      • Certifications (Industry)
        • Return the partner entry industry certifications
        • Create a new partner entry industry certification
        • Return the details of a partner entry industry certification
        • Update a partner entry industry certification
        • Delete a partner entry industry certification
      • Certifications (Segment)
        • Return the partner entry segment certifications
        • Create a new partner entry segment certification
        • Return the details of a partner entry segment certification
        • Update a partner entry segment certification
        • Delete a partner entry segment certification
      • Entry Edits Approval Flow
        • Reject partner entry changes
        • Partner Entry Submit Review
        • Partner Entry Discard Review
        • Partner Entry Approve Review
      • Keywords
        • Return Keyword details
        • Create a new keyword
        • Return Keyword details
        • Update keyword details
        • Delete a keyword
      • Locations
        • Return Location details
        • Create a new location
        • Return Location details
        • Update location details
        • Delete a location
      • Media
        • Retrieve a profile media within an entry in a directory
        • Retrieve a list of profile media within an entry in a directory
        • Create new profile media
        • Update profile media
        • Delete profile media
      • Resources
        • Return Internal Resource details
        • Create a new internal resource
        • Return Internal resource details
        • Update internal resource details
        • Delete an internal resource
        • Return Resource details
        • Create a new resource
        • Return Resource details
        • Update resource details
        • Delete a resource
      • Special Offers
        • Return Special Offer details
        • Create a new special offer
        • Return Special Offer details
        • Update special offer details
        • Delete a special offer
      • Testimonials
        • Return a list with Internal Testimonial details
        • Return Internal Testimonial details
        • Create a new internal testimonial
        • Update internal testimonial details
        • Delete an internal testimonial
        • Return Testimonial details
        • Create a new testimonial
        • Return Testimonial details
        • Update testimonial details
        • Delete a testimonial
      • Use Cases
        • Return a list with internal use cases details
        • Create a new internal use case
        • Return internal use cases details
        • Update internal use case details
        • Delete an internal use case
        • Return a list with use cases details
        • Create a new use case
        • Return use cases details
        • Update use case details
        • Delete a use case
      • Verifications
        • Return the list of verifications assigned to partner entry
        • Create a new partner entry verification
        • Return the details of a partner entry verification
        • Update a partner entry verification
        • Delete a partner entry verification
      • Create new partner entry
        POST
      • Update partner entry details
        PATCH
      • Delete partner entry
        DELETE
      • Returns the details of a Partner entry from a directory
        GET
      • Returns the internal details of a Partner entry from a directory
        GET
      • Update the recommended order of a partner entry
        POST
    • Authenticated endpoint that return a paginated list of entries for an specific directory
      GET
  • Organization
    • Returns the paginated list of all Partner Entry Owner Organization invites
    • Returns a paginated list of all the entries of an organization from all the directories that its listed
    • Retrieve a list of contact requests for an entry owner organization
    • Get api directory private v1alpha organizations external analytics
    • Return the directory details of an Organization
  • Client
    • Return Client details
    • Create a new client
    • Return Client details
    • Update special client details
    • Delete a client
  • Others
    • Get listed with an authenticated user with an existing organization
    • Return partners assigned to matchmaking requests
    • Replace api directory private v1alpha directories matchmaking-requests partners
    • Return the contact information of a specific directory entry
    • Get api directory private v1alpha entries partners invite matches
    • Get api directory private v1alpha entries partners invite organization
    • Create api directory private v1alpha entries partners invite organization
    • Get api directory private v1alpha entries partners invite users
    • Create api directory private v1alpha entries partners invite users
    • Retrieve details of a contact requests for an entry owner organization
    • Retrieve details of a contact requests for an entry owner organization
    • Entry owner accepts a specific contact request
    • Entry owner declines a specific contact request
    • Return the details of an App Entry owned by an Organization
    • Update an App Entry owned by an Organization
    • Returns the paginated list of all Partner Entry Owner Organization invites
    • Returns a partner entry owner organization invite details
    • Accepts an invite for an organization to own a partner entry
    • Rejects an invite for an organization to own a partner entry
    • Return the details of a partner entry owned by an Organization
    • Update a partner entry owned by an Organization
  • Contact Request
    • Retrieve details of a contact requests for a directory owner organization
    • Retrieve a list of contact requests for a directory owner organization
  • Matchmaking
    • Return a list of possible matchmaking request owners
    • Allows an authenticated user to assign an owner (by ID) to a matchmaking request
    • Return details of a matchmaking request for a directory owner
  1. Partner Entry

Returns the details of a Partner entry from a directory

GET
https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/{directory_id}/entries/partners/{entry_id}/
Returns the details of a Partner entry from a directory.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories//entries/partners//' \
--header 'Authorization;'
Response Response Example
200 - response
{
    "id": "237ff0f4-e9d5-4be6-a21a-5c913836d523",
    "href": "/api/directory/private/v1alpha/directories/e2b2a65f-0972-4fb4-96bb-498a63411bb6/entries/partners/237ff0f4-e9d5-4be6-a21a-5c913836d523/",
    "title": "The Best Partner",
    "headline": "The App headline.",
    "description": "The partner that you were waiting for!",
    "icon": "https://image.domain.com/icon.png",
    "image": "https://image.domain.com/partner.png",
    "slug": "the-best-partner",
    "custom_slug": null,
    "status": "public",
    "featured": true,
    "owner": "7f80323b-dc05-4002-a2a0-89c627c2dc82",
    "website": "https://the.partner.website.com",
    "location": "Dublin, Dublin, Ireland",
    "call_to_action_url": "https://just.do.it.com/",
    "call_to_action_label": "Call to action Label",
    "external_url": "https://external.partner.url.com/",
    "support_email": "support@partner.website.com",
    "developer_name": "The Best Partner Developer",
    "metadata": {
        "external_id": "158a0557-8918-4311-bc57-fb5f69c093c1"
    },
    "award": "https://image.domain.com/award.png",
    "use_cases": [
        {
            "id": "aab920e3-a5da-4a59-89d6-44591ddea8ad",
            "title": "Use Case 1",
            "description": "Use Case 1 description",
            "order": 0
        }
    ],
    "callouts": [
        {
            "id": "68c18fe3-9450-44dd-bc57-b332c53ce069",
            "name": "One Callout",
            "order": 0,
            "textColor": "635BFF",
            "backgroundColor": "E8E6FF"
        }
    ],
    "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",
            "type": "I"
        }
    ],
    "resources": [
        {
            "id": "e4f88344-ec9d-438b-9e05-f2f4cc89ed88",
            "title": "Entry Resource",
            "url": "https://partner.domain.com/resource",
            "file": null,
            "order": 0
        }
    ],
    "special_offers": [
        {
            "id": "e4f88344-ec9d-438b-9e05-f2f4cc89ed88",
            "title": "Entry Special Offer",
            "url": "https://partner.domain.com/special-offer",
            "file": null,
            "order": 0
        }
    ],
    "clients": [
        {
            "id": "e4f88344-ec9d-438b-9e05-f2f4cc89ed88",
            "title": "Client Entry",
            "url": "https://client.domain.com/client",
            "file": null,
            "order": 0
        }
    ],
    "testimonials": [
        {
            "id": "134427f8-d25e-466a-806e-7145523a471e",
            "author_name": "John Doe",
            "position": "Project Manager",
            "company_name": "Company Inc.",
            "testimonial_text": "This is a great testimonial",
            "order": 0
        }
    ],
    "certifications": [
        {
            "id": "b2a0414d-f05d-4f34-a2f3-990116b9cdfd",
            "title": "Certification 3 (order 0)",
            "quantity": 14
        },
        {
            "id": "8fb8379e-7049-4bb9-95d4-a3017d235789",
            "title": "Certification 1 (order 1)",
            "quantity": 14
        },
        {
            "id": "85929f1d-10e3-459a-8e2d-622ed16d5110",
            "title": "Certification 2 (order 2)",
            "quantity": 1
        }
    ],
    "verifications": [
        {
            "id": "5a4045d7-9dbb-49ee-9132-180665dcdc3b",
            "title": "A Verification"
        },
        {
            "id": "ada6a021-e996-4d12-85dd-1d5220f67da4",
            "title": "B Verification"
        }
    ],
    "tracking": {
        "umami_website_id": "ed2faba6-7aec-459a-b997-97fcfc390709",
        "umami_share_id": "1xdfagJ"
    },
    "display_on_internal_directory": false,
    "tier": {
        "title": "Tier Test",
        "default": false,
        "image": "https://images/tier-image.png",
        "order": 3,
        "id": "a8216d76-beb5-4b10-a280-cb23fd031245",
        "entriesCount": 1,
        "entriesListUrl": "/api/directory/private/v1alpha/directories/efc35140-2c3f-4936-a3f8-b700ecafe6b5/tiers/a8216d76-beb5-4b10-a280-cb23fd031245/entries/"
    }
}

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Path Params
directory_id
string <uuid>
required
id of the directory
entry_id
string <uuid>
required
id of the Partner entry

Responses

🟢200OK
application/json
Successful operation
Body
href
string 
Href
read-onlyoptional
id
string <uuid>
Id
required
title
string 
Title
required
>= 1 characters<= 256 characters
headline
string  | null 
Headline
required
>= 1 characters<= 250 characters
type
string 
Type
required
>= 1 characters<= 100 characters
slug
string <slug>
Slug
required
>= 1 characters<= 60 characters
Match pattern:
^[-a-zA-Z0-9_]+$
customSlug
string <slug> | null 
Custom slug
required
>= 1 characters<= 60 characters
Match pattern:
^[-a-zA-Z0-9_]+$
status
enum<string> 
Status
required
Allowed values:
hiddeninactivepublicsearchable
icon
string  | null 
Icon
required
>= 1 characters
image
string  | null 
Image
required
>= 1 characters
website
string <uri> | null 
Website
required
>= 1 characters
featured
boolean 
Featured
required
owner
object  | null 
Owner
required
Additional properties
string  | null 
optional
userAssignedFilterOptions
string 
User assigned filter options
read-onlyoptional
systemAssignedFilterOptions
string 
System assigned filter options
read-onlyoptional
mappedAssignedFilterOptions
string 
Mapped assigned filter options
read-onlyoptional
description
string  | null 
Description
required
>= 1 characters
integrationDescription
string  | null 
Integration description
optional
location
string  | null 
Location
required
>= 1 characters<= 255 characters
callToActionUrl
string <uri> | null 
Call to action url
required
>= 1 characters
callToActionLabel
string  | null 
Call to action label
required
>= 1 characters<= 25 characters
internalPointOfContactCtaUrl
string <uri> | null 
Internal point of contact cta url
optional
internalPointOfContactCtaLabel
string  | null 
Internal point of contact cta label
optional
<= 25 characters
internalChannelContactCtaUrl
string <uri> | null 
Internal channel contact cta url
optional
internalChannelContactCtaLabel
string  | null 
Internal channel contact cta label
optional
<= 25 characters
externalUrl
string <uri> | null 
External url
required
>= 1 characters
externalId
string  | null 
External id
required
>= 1 characters<= 100 characters
resources
array[object (ResourceSerializerReader) {5}] 
required
title
string  | null 
Title
optional
>= 1 characters<= 255 characters
file
string  | null 
File
optional
>= 1 characters
url
string <uri> | null 
Url
optional
>= 1 characters<= 200 characters
order
integer 
Order
optional
>= 0
id
string <uuid>
Id
required
award
string <uri> | null 
Award
required
>= 1 characters
verifications
array[object (VerificationAssignment) {2}]  | null 
optional
id
string <uuid>
Id
required
title
string 
Title
required
>= 1 characters<= 35 characters
media
array[object (ProfileMediaSerializerReader) {8}]  | null 
optional
id
string <uuid>
Id
required
title
string  | null 
Title
required
>= 1 characters<= 150 characters
description
string  | null 
Description
required
>= 1 characters
order
integer  | null 
Order
required
>= 0
pdfFileThumbnailUrl
string  | null 
Pdf file thumbnail url
required
>= 1 characters
url
string <uri> | null 
Url
required
>= 1 characters
file
string <uri> | null 
File
required
>= 1 characters
type
string  | null 
Type
required
>= 1 characters
callouts
array[object (PartnerAssignedCalloutSerializerReader) {6}] 
optional
order
integer 
Order
optional
>= 0<= 5
href
string 
Href
read-onlyoptional
name
string 
Name
required
>= 1 characters<= 35 characters
textColor
string  | null 
Text color
optional
>= 1 characters<= 7 characters
Match pattern:
^#?([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
backgroundColor
string  | null 
Background color
optional
>= 1 characters<= 7 characters
Match pattern:
^#?([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
id
string <uuid>
Id
required
keywords
array[object (KeywordSerializerReader) {2}] 
optional
name
string  | null 
Name
optional
>= 1 characters<= 50 characters
id
string <uuid>
Id
required
supportEmail
string  | null 
Support email
required
>= 1 characters<= 250 characters
developerName
string  | null 
Developer name
required
>= 1 characters<= 250 characters
displayOnInternalDirectory
boolean  | null 
Display on internal directory
optional
internalDescription
string  | null 
Internal description
optional
metadata
string 
Metadata
read-onlyoptional
certifications
string 
Certifications
read-onlyoptional
tracking
object (Tracking) 
required
umamiWebsiteId
string <uuid> | null 
Umami website id
required
umamiShareId
string  | null 
Umami share id
required
>= 1 characters<= 100 characters
internalUmamiWebsiteId
string <uuid> | null 
Internal umami website id
optional
internalUmamiShareId
string  | null 
Internal umami share id
optional
>= 1 characters<= 100 characters
approvalFlow
string 
Approval flow
read-onlyoptional
tier
object (TierSerializerReader)  | null 
required
title
string 
Title
required
>= 1 characters<= 150 characters
default
boolean  | null 
Default
optional
image
string  | null 
Image
optional
>= 1 characters
order
integer 
Order
optional
>= 0
id
string <uuid>
Id
required
entriesCount
integer 
Entries count
required
entriesListUrl
string 
Entries list url
required
>= 1 characters
🟠404Record Not Found
Modified at 2025-07-14 17:47:22
Previous
Delete partner entry
Next
Returns the internal details of a Partner entry from a directory
Built with