Welcome

The CMS API gives you read access to the published content of your marketplace (listings, categories, filters, templates and marketplace settings), so you can build your own marketplace experience or show marketplace content on another site. It also lets you submit lead forms and record visitor events.

Which PartnerFleet API do I need?

Each API uses its own kind of key. You can use your marketplace's custom domain in place of the PartnerFleet subdomain.

Get an API key

Every CMS API endpoint requires an API key that belongs to an admin user of your marketplace. Each admin creates keys on their own account:

1. In the PartnerFleet admin, open the account menu in the top right (your company logo and name) and click Account Management.
2. In the menu on the left of your account page, click API Keys.
3. Click New API Key, give it a name, optionally set an expiry date, and save.
4. Copy the value in the Access Token column.

A key works only while its user is an admin, and only on the domains of the account it was created in.

Authenticate

Send the key in the Authorization header:

Authorization: Bearer <api-key>

You can also pass it as the api_key query parameter, but the header keeps the key out of URLs and logs. Requests without a valid key, with an expired key, or with a key whose user is not an admin return 401 Unauthorized.

Use your marketplace's domain

The domain identifies your account and the marketplace: listing search, category, filter and settings endpoints return data for the marketplace that serves the domain.

Pagination

The endpoints that list and search listings are paginated. They accept page (starting at 1) and per_page, and 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.

Other list endpoints return all results in a single response.

Errors

Errors return a JSON body with a single error message, for example { "error": "You are not authorized to access this page." }.

Lead submissions report a rejected submission in the response body rather than with an error status; see Submit a lead.