PartnerPage API
  1. Branding
PartnerPage API
  • Introduction
  • Authentication
  • Object Overview
  • Directory
    • Branding
      • Retrieve a directory's branding
        GET
      • Update a directory's branding
        PATCH
    • 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
      • Update partner entry details
      • Delete partner entry
      • Returns the details of a Partner entry from a directory
      • Returns the internal details of a Partner entry from a directory
      • Update the recommended order of a partner entry
    • 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
      GET
    • Returns a paginated list of all the entries of an organization from all the directories that its listed
      GET
    • Retrieve a list of contact requests for an entry owner organization
      GET
    • Get api directory private v1alpha organizations external analytics
      GET
    • Return the directory details of an Organization
      GET
  • 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. Branding

Retrieve a directory's branding

GET
https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/{directory_id}/branding/
Retrieves the details of a directory's branding that has previously been created. Supply the unique directory ID that was returned from your previous request, and PartnerPage will return the corresponding directory branding information.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories//branding/' \
--header 'Authorization;'
Response Response Example
200 - response
{
    "href": "/api/directory/private/v1alpha/directories/e6704845-131a-43b7-a72f-56fbb0c6e72d/branding/",
    "genericDirectoryId": "e6704845-131a-43b7-a72f-56fbb0c6e72d",
    "logo": "https://branding.logo.example.com",
    "internalLogo": null,
    "favicon": "https://branding.favicon.example.com",
    "internalFavicon": null,
    "interactiveColor": "#635BFF",
    "actionPrimaryColor": "#635BFF"
}

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Path Params
directory_id
string 
required

Responses

🟢200OK
application/json
Successful operation
Body
href
string 
Href
read-onlyoptional
genericDirectoryId
string <uuid>
Generic directory id
required
The unique identifier of a directory in PartnerPage's app. Your directory UUIDs can be looked up using the /api/directory/internal/v1alpha/directories/ endpoint.
logo
string <uri> | null 
Logo
required
The logo to be displayed on the public directory.
>= 1 characters
internalLogo
string <uri> | null 
Internal logo
required
The logo to be displayed on the internal directory, if enabled for your account.
>= 1 characters
favicon
string <uri> | null 
Favicon
required
The small icon displayed in the browser tab, bookmarks, and address bar for the public directory.
>= 1 characters
internalFavicon
string <uri> | null 
Internal favicon
required
The small icon displayed in the browser tab, bookmarks, and address bar for the internal directory, if enabled for your account.
>= 1 characters
interactiveColor
string  | null 
Interactive color
required
The color to be used for UI elements on the directory when a user interacts with them, as a HEX string.
>= 1 characters<= 7 characters
Example:
#635BFF
actionPrimaryColor
string  | null 
Action primary color
required
The color of primary calls to action on the directory, as a HEX string.
>= 1 characters<= 7 characters
Example:
#635BFF
🟠404Record Not Found
🔴500Server Error
Modified at 2025-07-14 23:14:36
Previous
Branding
Next
Update a directory's branding
Built with