Start
Guides
Concepts
API endpoints
GET
List redirect rules
https://linkshift.app/api/v1/redirect-rulesCursor-style pagination ordered by `priority desc, createdAt desc, id desc`.
Operation ID:
listRedirectRulesTags: Redirect RulesSecurity
- ApiKeyAuth: apiKey | header:X-API-Key | API key generated in LinkShift dashboard (`Organization -> Manage API keys`).
Parameters
Query parameters
domainGroupIdrequired
Type: stringDescription: Domain group scope for listing rules.
limit
Type: integerDescription: Maximum number of items to return (cursor page size).
search
Type: stringDescription: Free-text search over rule source/destination fields.
startAfterId
Type: stringDescription: Cursor token using the last item ID from previous page.
Request body schema
No request body schema.
Response schema
Redirect rules list
Content type:
application/jsonresponse 200objectrequired
Paginated redirect-rule query response.
dataarray of objectrequired
Redirect-rule items in current page.
blockedAtstring | nullnullable
Timestamp when the rule was blocked.
createdAtstringrequired
Creation timestamp (UTC).
deletedAtstring | nullnullable
Soft-delete timestamp in UTC when deleted.
destinationstring | nullnullable
Static redirect destination URL. Null when dynamic destination is used via link map.
domainGroupIdstringrequired
Parent domain-group ID.
idstringrequired
Redirect-rule ID.
isBlockedboolean
Whether the rule is currently blocked from execution.
linkMapIdstring | nullnullable
Optional linked map used for key-based destinations.
matchMethodarray of stringrequired
Allowed request methods. Empty array means all methods.
pathMatchstringrequired
Path matching strategy.
priorityintegerrequired
Rule priority (higher first).
queryMatchstringrequired
Query-string matching strategy.
sourcestringrequired
Source matcher expression.
statusCodeintegerrequired
HTTP redirect status returned for matches.
updatedAtstringrequired
Last update timestamp (UTC).
dataTypestringrequired
Logical item type in the `data` array.
hasMorebooleanrequired
Whether there are additional results after this page.
moreStartingAfterIdstring
Cursor token to request the next page.