> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an author

> Retrieve a specific author by ID.

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$author = Attract::authors()->getAuthor(id: 'clx8m2k4p0000a1b2c3d4e5f6');
```

```json 200 wrap theme={"dark"}
{
  "title": "Example title",
  "bio": "Example bio",
  "_user": [
    {}
  ],
  "showOnSite": true,
  "showPhoto": true,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}
```

## In your app

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

**1. Add the controller**

```php app/Http/Controllers/GetAuthorController.php theme={"dark"}
<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class GetAuthorController
{
    public function __invoke(string $id): Author
    {
        return Attract::authors()->getAuthor(id: $id);
    }
}
```

**2. Add the route**

```php routes/web.php theme={"dark"}
use App\Http\Controllers\GetAuthorController;
use Illuminate\Support\Facades\Route;

Route::get('/author/{id}', GetAuthorController::class);
```

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:8000/author/clx8m2k4p0000a1b2c3d4e5f6
```

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

> [!TIP]
>
> To keep the call in an Action instead, this writes `app/Actions/Attract/GetAuthor.php` (an invokable Action that calls `getAuthor()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action authors.getAuthor
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call authors.getAuthor id=clx8m2k4p0000a1b2c3d4e5f6
```

It calls `getAuthor()` on your default site and prints its answer as JSON. See [Call any method from the terminal](https://docs.fetchski-attract.com/call-command.md) 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.

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

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

```bash Terminal theme={"dark"}
php artisan attract:call authors.listAuthorsPick fields=title,slug
```

Pass `$row['id']` as `id`. Drafts: list with `aposMode: 'draft'` to get the draft’s id ([Find an id](https://docs.fetchski-attract.com/find-an-id.md)).

> [accordion] Required parameters
>
> Named arguments, e.g. `getAuthor(id: …)`; leave out the optional ones.
>
> **id** `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`).

> [accordion] Optional parameters
>
> **aposMode** `Enums\\AposMode|string|null`
>
> **Optional.** Leave it out and the site uses `"published"`. `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content:<type>:write`), or a signed-in editor. The public and a key with only the read scope get 403. One of `draft`, `published`.
>
> **aposLocale** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. `en` (default: the site’s default locale).
>
> **renderAreas** `?bool`
>
> **Optional.** Leave it out and the site uses `false`. true: each area’s widgets come back rendered as HTML (`_rendered`), beside their data.

> [accordion] Returns
>
> An `Author` (`Fetchski\AttractCmsLaravel\Data\Author`). Author content type. Read its properties (`$author->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`, `_user` → `user`).
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **id** `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.
>
> **type** `string`
>
> **Always sent.** The document type’s name: always this type’s.
>
> **bio** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Optional one or two sentences about this author.
>
> **user** `Collection\<int, array\<string, mixed\>\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. The FetchskiCMS login account this author profile belongs to (used to source the photo, and by SSO to sync it). Leave empty for guest contributors. The related `@apostrophecms/user` 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.
>
> **showOnSite** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Master switch for this author’s public byline. Turn off to hide the name AND photo on every post that credits this author.
>
> **showPhoto** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. When on, the linked login account’s profile photo appears next to this author. Has no effect without a login account, or when “Show author on the site” is off.
>
> **slug** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **visibility** `Enums\\Visibility|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Select whether this content is public or private. One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.
>
> **scheduledPublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **scheduledUnpublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **archived** `?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.
>
> **createdAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **aposShareKey** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The draft’s preview share key, while its share link is on: the link is the draft’s `_url` with `aposShareKey` and `aposShareId` (the draft’s `_id`) in its query. Absent otherwise, and on published documents.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see [Errors and testing](https://docs.fetchski-attract.com/laravel/errors.md)).
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors()` lists each field’s problem, `siteMessage()` the first.
>
> **Retried first:** No. **Read:** `errors()` (field → messages), `siteMessage()`.
>
> **AuthenticationFailed** `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()`.
>
> **Forbidden** `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()`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No (only a 502, 503 or 504 is retried). **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **SiteUnreachable** `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()`.
>
> **RequestNotSent** `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).
>
> **SiteRequestFailed** `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()`.
>
> **UnknownSite** `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`.
>
> **SiteConfigurationError** `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:authors:read` (or a master above it: `content:authors:all`, `content:all`, `admin:all`) reads the published documents; drafts (`aposMode=draft`, or a draft `_id`) need `content:authors:write` (or a master above it). A signed-in person reads as far as their own permissions allow, and anyone else reads the published documents’ public fields.
* **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

```php Or null wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$author = Attract::authors()->findAuthor(id: 'clx8m2k4p0000a1b2c3d4e5f6'); // ?Author: 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/GetAuthorTest.php`, then run your tests:

```php tests/Feature/GetAuthorTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class GetAuthorTest extends TestCase
{
    public function test_get_author(): void
    {
        Attract::fake();

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

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

```bash Terminal theme={"dark"}
php artisan test
```

**Answer with your own values:** fake `authors.getAuthor` with `Author::factory()->make([...])`, the fields you give over a valid example.

```php tests/Feature/GetAuthorAnswerTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class GetAuthorAnswerTest extends TestCase
{
    public function test_get_author_answers_your_values(): void
    {
        Attract::fake([
            'authors.getAuthor' => Author::factory()->make(['title' => 'Your value']),
        ]);

        $author = Attract::authors()->getAuthor(id: 'clx8m2k4p0000a1b2c3d4e5f6');

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

## Related

> [card] [List an author’s locales](https://docs.fetchski-attract.com/laravel/reference/authors/get-author-locales.md)
>
> `Attract::authors()->getAuthorLocales()`

> [card] [List authors](https://docs.fetchski-attract.com/laravel/reference/authors/list-authors.md)
>
> `Attract::authors()->listAuthors()`

> [card] [Create an author](https://docs.fetchski-attract.com/laravel/reference/authors/create-author.md)
>
> `Attract::authors()->createAuthor()`

> [card] [Replace an author](https://docs.fetchski-attract.com/laravel/reference/authors/replace-author.md)
>
> `Attract::authors()->replaceAuthor()`

> [card] [Delete an author](https://docs.fetchski-attract.com/laravel/reference/authors/delete-author.md)
>
> `Attract::authors()->deleteAuthor()`

> [card] [Update an author](https://docs.fetchski-attract.com/laravel/reference/authors/update-author.md)
>
> `Attract::authors()->updateAuthor()`

> [card] [GET /author/\{\_id}](https://docs.fetchski-attract.com/api-reference/authors/get-an-author.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.