Welcome

Manage listings, partners, users, submissions, leads, categories and filters from your own systems.

The Admin API lets you manage your marketplace from your own systems: create and update listings and their content, keep partners, partner accounts and users in sync with your CRM, review partner submissions and leads, and maintain categories and filters.

Building something new? The Core API (Admin API v2) is PartnerFleet's current API for listings, customer accounts and attached integrations, with keys you create yourself and per-permission access.

Base URL

Send every request to your marketplace's domain, followed by /admin_api: either its PartnerFleet subdomain or your custom domain.

https://<your-marketplace>.partnerfleet.app/admin_api

Endpoint paths start with /api/admin, for example GET /api/admin/listings. The domain identifies the marketplace, so a key only works on the marketplace it was issued for.

Get your Admin API key

Every endpoint requires your marketplace's Admin API key. This key is issued by PartnerFleet and is not tied to a user. Contact your PartnerFleet account team to obtain it.

It is a different key from the CMS API keys created under Users & Invites and the Core API keys created under Settings → Advanced → API Keys. Store it securely and keep it out of client-side code.

Authenticate

Send the key in the Authorization header:

Authorization: Bearer <api-key>

Requests without a valid key, or with an expired key, return 401 Unauthorized.

The one exception is GET /api/admin/users/me, which identifies the user who signed in to your application with PartnerFleet. It takes that user's OAuth access token instead of the Admin API key (authorization code flow at /admin/oauth/authorize and /admin/oauth/token, scope user_details).

Pagination

List endpoints that accept page (starting at 1) and per_page come in two shapes:

  • With links: the lists of partners, partner accounts, users, submissions, events and G2 listings return the results in data and navigation URLs in links. first and last are always present; next and prev appear only when that page exists.
  • Plain arrays: the lists of listings, listing sections, leads and roles return a JSON array with no links. Request the next page until you receive fewer results than per_page.

List endpoints that don't take page return all results in a single response.

Errors

Errors return a JSON body with a single error message:

{ "error": "You are not authorized to access this page." }

The listing list (for an invalid sort_by) and the AI listing generation endpoints return their own errors as error_code and error_message instead:

{ "error_code": 422, "error_message": "Invalid sort_by parameter" }
StatusMeaning
400A required parameter is missing or has the wrong type.
401The API key is missing, invalid or expired.
403AI listing generation is not available for your marketplace.
404The requested record does not exist in this marketplace.
422The request was understood but could not be saved (validation failed).
500AI listing generation failed; the message says why.