List redirects

Retrieve all redirects for the authenticated user

Endpoint

GET /get-redirects/me

Function signature

export const getUserRedirects = async (): Promise<AxiosResponse>

Parameters

This endpoint does not require any parameters. It automatically fetches redirects for the authenticated user.

Response

status · number

HTTP status code

data · array

Array of redirect objects

Show Redirect object properties

id · string

Unique identifier for the redirect

fromDomain · string

The source domain

toDomain · string

The destination domain

redirectType · string

Either permanent or temporary

pathForwarding · boolean

Whether path forwarding is enabled

queryForwarding · boolean

Whether query parameter forwarding is enabled

samplingRate · number

Analytics sampling rate (0 to 1)

createdAt · string

Timestamp when the redirect was created

updatedAt · string

Timestamp when the redirect was last updated

Code example

Example

import { getUserRedirects } from '@/lib/api';

const fetchRedirects = async () => {
  const response = await getUserRedirects();
  const redirects = response.data;
  
  console.log(`Total redirects: ${redirects.length}`);
  return redirects;
};

This endpoint requires authentication. Ensure the user is logged in before making this request.

Error responses

Show 401 - Unauthorized

Returned when the user is not authenticated

Show 500 - Internal Server Error

Returned when an unexpected error occurs on the server