How does the API work?

The API can be used to manage your redirects.

Authentication

When logged into your account, navigate to the 'API' tab. Here you can find your Team's API token. You can use this API token as the Bearer token in the JSON RESTful API:

curl --header "Authorization: Bearer rpa_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
https://redirect.pizza/api/v1/redirects

The following endpoints are available:

Redirects

GET /api/v1/redirects: List all redirects.

GET /api/v1/redirects/$REDIRECTID$: Show a specific redirect by it's ID. You can fetch the ID from the list call or from the control panel.

POST /api/v1/redirects: Add a new redirect

PATCH /api/v1/redirects: Update an existing redirect

DELETE /api/v1/redirects/$REDIRECTID$: Delete a redirect

Email forwards

GET /api/v1/email-forwards: List all email forwards.

GET /api/v1/email-forwards/$EMAILFORWARDID$: Show a specific email forward by it's ID. You can fetch the ID from the list call or from the control panel.

POST /api/v1/email-forwards: Add a new email forward

PATCH /api/v1/email-forwards: Update an existing email forward

DELETE /api/v1/email-forwards/$EMAILFORWARDID$: Delete a email forward

Team

GET /api/v1/team: View team quota details

View our API documentation

More articles

Can’t find the answer you’re looking for?

E-mail us
support@redirect.pizza
Start a chat
Online 9:00 - 21:00 CEST
Phone
Available with Enterprise