Skip to main content

In your app

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

Add the controller

app/Http/Controllers/GetTeamMemberController.php

Add the route

routes/web.php

Call it

Terminal
With php artisan serve running, it prints its answer as JSON.
To keep the call in an Action instead, this writes app/Actions/Attract/GetTeamMember.php (an invokable Action that calls getTeamMember()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):
Terminal

Call it from the terminal

Terminal
It calls getTeamMember() 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
Terminal
Pass $row['id'] as id. Drafts: list with aposMode: 'draft' to get the draft’s id (Find an id).

Required parameters

Named arguments, e.g. getTeamMember(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).
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.
?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).
?bool
Optional. Leave it out and the site uses false. true: each area’s widgets come back rendered as HTML (_rendered), beside their data.
A TeamMember (Fetchski\AttractCmsLaravel\Data\TeamMember). TeamMember content type. Read its properties ($teamMember->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, _photo → photo, _hoverPhoto → hoverPhoto).
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. 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.
?string
Sometimes sent: null when the site leaves it out. e.g. “Founder” or “Operations lead”.
?string
Sometimes sent: null when the site leaves it out. Optional one-liner shown on the compact card layouts — a motto, specialty or fun fact.
?string
Sometimes sent: null when the site leaves it out. Optional short biography, shown on the roomier card layouts.
Sometimes sent: null when the site leaves it out. Hand-curation flag. The widget can show only featured members, and the Spotlight layout renders them large.
?int
Sometimes sent: null when the site leaves it out. Members are listed lowest number first — the explicit team order.
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.
?string
Sometimes sent: null when the site leaves it out. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
?string
Sometimes sent: null when the site leaves it out. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
Collection<int, TeamMemberMemberFontOverridesItem>|null
Sometimes sent: null when the site leaves it out. A list of TeamMemberMemberFontOverridesItem. Optional. Set part of this team member’s card in a different typeface. Leave empty to follow the section (and the site fonts). At most 4 items.
Collection<int, array<string, mixed>>|null
Sometimes sent: null when the site leaves it out. Optional headshot from the media library. Falls back to the Photo URL below, then to a lettered-initial avatar. The related @apostrophecms/image 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. Alternative to uploading: a full https:// link to a photo hosted elsewhere. Only used when no Photo is selected above — prefer uploading when you can (it enables cropping, focal point and responsive sizes). When set, a URL; empty or null when not.
Collection<int, array<string, mixed>>|null
Sometimes sent: null when the site leaves it out. Optional second photo (e.g. a candid shot) that cross-fades in when a visitor hovers the card. Needs the Team section’s hover-photo toggle on. The related @apostrophecms/image 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. URL alternative to the alternate photo above — only used when none is selected. Same hover behavior. When set, a URL; empty or null when not.
?string
Sometimes sent: null when the site leaves it out. Optional. Only shown when the Team section has “Show email / phone” turned on. When set, an email address; empty or null when not.
?string
Sometimes sent: null when the site leaves it out. Optional. Only shown when the Team section has “Show email / phone” turned on.
Sometimes sent: null when the site leaves it out. A list of TeamMemberSocialLinksItem. Each profile is optional — add only the networks you use. A link only appears once it has a URL. Pick a platform for its brand icon, or “Other / custom” to choose any icon.
Enums\FaqCategorySource|string|null
Sometimes sent: null when the site leaves it out. Set automatically. Demo placeholders are removed the moment a real member is published. One of manual, demo; a newer site may send others, so keep a fallback.
?string
Sometimes sent: null when the site leaves it out. Internal de-duplication key set by the demo seed.
?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.
?CarbonImmutable
Sometimes sent: null when the site leaves it out. When it was created (ISO 8601). Format: an ISO 8601 date and time.
?CarbonImmutable
Sometimes sent: null when the site leaves it out. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
?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.
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:team-members:read (or a master above it: content:team-members:all, content:all, admin:all) reads the published documents; drafts (aposMode=draft, or a draft _id) need content:team-members: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

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/GetTeamMemberTest.php, then run your tests:
tests/Feature/GetTeamMemberTest.php
Terminal
Answer with your own values: fake teamMembers.getTeamMember with TeamMember::factory()->make([...]), the fields you give over a valid example.
tests/Feature/GetTeamMemberAnswerTest.php

List a team member’s locales

Attract::teamMembers()->getTeamMemberLocales()

List team members

Attract::teamMembers()->listTeamMembers()

Create a team member

Attract::teamMembers()->createTeamMember()

Replace a team member

Attract::teamMembers()->replaceTeamMember()

Delete a team member

Attract::teamMembers()->deleteTeamMember()

Update a team member

Attract::teamMembers()->updateTeamMember()

GET /team-member/{_id}

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