Disponible en el plan Marketer y superiores.
This page is a high-level orientation. The full, always-up-to-date REST API reference lives inside your WordPress admin — go to Dashboard > Pretty Links > Developer Tools > Docs for complete request and response examples.
Esta guía forma parte de la Descripción general del complemento «Pretty Links Developer Tools», the entry point for the Developer Tools add-on.
Where to Find the Full Reference
En la barra lateral de administración de WordPress, ve a Dashboard > Pretty Links > Developer Tools > Docs.
The Docs tab shows every endpoint with its HTTP method, parameters, request body shape, response shape, and example calls. Because it’s served from inside your install, it always matches your actual version of Pretty Links — no stale online docs to worry about.
Open the Docs tab in a second browser tab while you work. It’s the source of truth.
Endpoint Overview
Here’s a quick map of what’s available, so you know what’s possible before you dig into the in-app docs.
Pretty Links (CRUD)
- List Pretty Links — Get all of your Pretty Links, with filtering and pagination;
- Get a single Pretty Link — Look up one link by ID;
- Create a Pretty Link — Add a new link programmatically. Useful for migrations, bulk imports, or auto-creating links from another system;
- Update a Pretty Link — Modify an existing link’s target URL, slug, redirect type, name, or other fields;
- Delete a Pretty Link — Trash or permanently remove a link.
Webhook Subscriptions
- Subscribe — Create a new webhook subscription programmatically (POST);
- Unsubscribe — Remove a webhook subscription by ID (DELETE).
These are useful when an external system needs to manage its own webhook subscription lifecycle — for example, an integration that wants to register itself when activated and clean up when deactivated. To view the current list of subscriptions, use the Webhooks screen in the admin.
Authentication
All endpoints require the site API key, sent in either the PRLI-API-KEY header or the Authorization header. See Claves de API for where to find it and how to regenerate it.
The REST namespace is pl/v1 — for example, https://yoursite.com/wp-json/pl/v1/links.
The in-app Docs tab shows the exact header format and a curl example you can copy.
Response Format
All responses are JSON. Successful responses return a 2xx status code with the relevant data in the body. Errors return a 4xx or 5xx status code with a JSON body describing what went wrong.
Standard HTTP conventions apply:
200 OK— Successful read;201 Created— Successful create;400 Bad Request— Your request was malformed;401 Unauthorized— Missing or invalid API key;404 Not Found— The link or resource doesn’t exist;500 Internal Server Error— Something went wrong on the server.
Tips for Working With the API
Start with a List call. The first request to try is “list all my Pretty Links.” It validates your API key, your URL format, and your tool’s setup — all in one go.
Read the in-app docs for exact field names. The list of fields on a Pretty Link is documented inside the admin. Don’t guess at field names; copy them from the docs to avoid typos.
Test create and update calls on a staging site first. A typo in a bulk-create script can produce hundreds of garbage links. Run against a staging environment, verify the result, then point at production.
Use webhooks instead of polling. If you find yourself calling the List endpoint on a schedule to check for changes, set up a webhook subscription instead. You’ll get changes pushed to you in real time, with no rate-limit concerns.
Check the event log if a webhook isn’t firing. Don’t assume — verify. The event log shows whether Pretty Links actually sent the request and what response your endpoint returned.
For everything else, the in-app Docs tab is the source of truth. Bookmark it.