Get a redirect

use Fetchski\AttractCmsLaravel\Facades\Attract;

$redirect = Attract::redirects()->getRedirect(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "redirectSlug": "example-slug",
  "urlType": "internal",
  "_newPage": [
    {}
  ],
  "externalUrl": "https://acme.example/example",
  "statusCode": "301",
  "ignoreQueryString": false,
  "forwardQueryString": false,
  "slug": "example-slug",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$redirect = Attract::redirects()->getRedirect(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "redirectSlug": "example-slug",
  "urlType": "internal",
  "_newPage": [
    {}
  ],
  "externalUrl": "https://acme.example/example",
  "statusCode": "301",
  "ignoreQueryString": false,
  "forwardQueryString": false,
  "slug": "example-slug",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

In your app

A controller answers a route on your app: it calls getRedirect() and returns the answer.

Add the controller

app/Http/Controllers/GetRedirectController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\Redirect;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class GetRedirectController
{
    public function __invoke(string $id): Redirect
    {
        return Attract::redirects()->getRedirect(id: $id);
    }
}

Add the route

routes/web.php

use App\Http\Controllers\GetRedirectController;
use Illuminate\Support\Facades\Route;

Route::get('/redirect/{id}', GetRedirectController::class);

Call it

Terminal

curl http://localhost:8000/redirect/clx8m2k4p0000a1b2c3d4e5f6

With php artisan serve running, it prints its answer as JSON.

To keep the call in an Action instead, this writes app/Actions/Attract/GetRedirect.php (an invokable Action that calls getRedirect()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action redirects.getRedirect

Call it from the terminal

Terminal

php artisan attract:call redirects.getRedirect id=clx8m2k4p0000a1b2c3d4e5f6

It calls getRedirect() on your default site and prints its answer as JSON. See Call any method from the terminal for every argument type.

Find the id

id is the document’s _id, from a list. Ask the list for only the fields you need: each row is a document’s id and those fields.

Laravel

use Fetchski\AttractCmsLaravel\Facades\Attract;

$row = Attract::redirects()->listRedirectsPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null

Terminal

php artisan attract:call redirects.listRedirectsPick fields=title,slug

Pass $row['id'] as id. See Find an id.

Required parameters

Named arguments, e.g. getRedirect(id: …); leave out the optional ones.

string

required

Required. The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

Optional parameters

?bool

Optional. Leave it out and the site uses false. true: each area’s widgets come back rendered as HTML (_rendered), beside their data.

Returns

A Redirect (Fetchski\AttractCmsLaravel\Data\Redirect). Redirect content type. Read its properties ($redirect->title): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (_id → id, _newPage → newPage).

string

Always sent. Its title: the name it goes by in every list, and the heading of its page where it has one.

string

Always sent. Format with leading slash (e.g., /old-url)

string

Always sent. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).

string

Always sent. The document’s id. On a type with drafts it ends in its locale and mode (…:en:published, …:en:draft): the part before the first colon is its aposDocId, shared by both copies. The {_id} the type’s routes take.

string

Always sent. The document type’s name: always this type’s.

CarbonImmutable

Always sent. When it was created (ISO 8601). Format: an ISO 8601 date and time.

CarbonImmutable

Always sent. When it last changed (ISO 8601). Format: an ISO 8601 date and time.

Enums\UrlType|string|null

Sometimes sent: null when the site leaves it out. Link Type. One of internal, external; a newer site may send others, so keep a fallback.

Collection<int, array<string, mixed>>|null

Sometimes sent: null when the site leaves it out. The related @apostrophecms/page documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out. At most 1 items.

?string

Sometimes sent: null when the site leaves it out. When set, a URL; empty or null when not.

Enums\StatusCode|string|null

Sometimes sent: null when the site leaves it out. Redirect Type. One of 302, 301; a newer site may send others, so keep a fallback.

?bool

Sometimes sent: null when the site leaves it out. Ignore query string when matching.

?bool

Sometimes sent: null when the site leaves it out. Forward query string.

?bool

Sometimes sent: null when the site leaves it out. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.

Errors

Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).

400

The site refused what was sent: errors() lists each field’s problem, siteMessage() the first.Retried first: No. Read: errors() (field → messages), siteMessage().

401

The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read: siteMessage(), errorName(), data().

403

The key may not do this: a scope it lacks, or an address outside its allowlist. siteMessage() names it.Retried first: No. Read: siteMessage(), errorName(), data().

404

Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage(), errorName(), data().

500

The site failed. Its logs say why.Retried first: No (only a 502, 503 or 504 is retried). Read: siteMessage(), errorName(), data().

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. Read: reason(), neverConnected().

not sent

The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason() (what to change).

any other

Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason(), status().

setup

Attract::site('acme') named a slug that isn’t under sites in config/fetchski-attract.php.Retried first: No: nothing was sent. Read: getMessage(), $e->slug.

setup

The site’s config entry is wrong: no url, a malformed api_key, a key filed under another slug, or no default site.Retried first: No: nothing was sent. Read: getMessage() (what to fix).

Behavior

Access: an API key with content:redirects:read (or a master above it: content:redirects:all, content:all, admin:all) reads the published documents. A signed-in person may call it as far as their own permissions allow; anyone else gets 404.
Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
Retries: a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
Timeout: 15 s per attempt by default; raise timeout in config/fetchski-attract.php for longer.

More examples

use Fetchski\AttractCmsLaravel\Facades\Attract;

$redirect = Attract::redirects()->findRedirect(id: 'clx8m2k4p0000a1b2c3d4e5f6'); // ?Redirect: null when the site answers 404

Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as tests/Feature/GetRedirectTest.php, then run your tests:

tests/Feature/GetRedirectTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class GetRedirectTest extends TestCase
{
    public function test_get_redirect(): void
    {
        Attract::fake();

        $this->getJson('/redirect/clx8m2k4p0000a1b2c3d4e5f6')->assertOk();

        Attract::assertCalled('redirects.getRedirect', fn (array $args): bool => $args['id'] === 'clx8m2k4p0000a1b2c3d4e5f6');
    }
}

Terminal

php artisan test

Answer with your own values: fake redirects.getRedirect with Redirect::factory()->make([...]), the fields you give over a valid example.

tests/Feature/GetRedirectAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Data\Redirect;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class GetRedirectAnswerTest extends TestCase
{
    public function test_get_redirect_answers_your_values(): void
    {
        Attract::fake([
            'redirects.getRedirect' => Redirect::factory()->make(['title' => 'Your value']),
        ]);

        $redirect = Attract::redirects()->getRedirect(id: 'clx8m2k4p0000a1b2c3d4e5f6');

        $this->assertSame('Your value', $redirect->title);
    }
}

List redirects

Attract::redirects()->listRedirects()

Create a redirect

Attract::redirects()->createRedirect()

Replace a redirect

Attract::redirects()->replaceRedirect()

Delete a redirect

Attract::redirects()->deleteRedirect()

Update a redirect

Attract::redirects()->updateRedirect()

Archive redirects

Attract::redirects()->archiveRedirects()

GET /@apostrophecms/redirect/{_id}

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

use Fetchski\AttractCmsLaravel\Facades\Attract;

$redirect = Attract::redirects()->getRedirect(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "title": "Example title",
  "redirectSlug": "example-slug",
  "urlType": "internal",
  "_newPage": [
    {}
  ],
  "externalUrl": "https://acme.example/example",
  "statusCode": "301",
  "ignoreQueryString": false,
  "forwardQueryString": false,
  "slug": "example-slug",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Call it from the terminal

Find the id

Behavior

More examples

Test it

List redirects

Create a redirect

Replace a redirect

Delete a redirect

Update a redirect

Archive redirects

GET /@apostrophecms/redirect/{_id}

In your app

Call it from the terminal

Find the id

Behavior

More examples

Test it

Related

List redirects

Create a redirect

Replace a redirect

Delete a redirect

Update a redirect

Archive redirects

GET /@apostrophecms/redirect/{_id}