Social API reference

Social API · Stories

get/v1/communities/{community_id}/actors/{actor_id}/close-friendsAuth

List the close-friends members of an actor.

Returns the actors on `external_id`'s close-friends list, with denormalised actor metadata. Cursor paginated.

Path parameters

community_id*string

Community UUID.

actor_id*string

Owner social actor UUID.

Query parameters

limitinteger

Maximum number of items to return (1-200, default 50).

cursorstring

Opaque cursor from the previous page's `pagination.next_cursor`; omit for the first page.

Response · 200 Page of close friends.

data*array

The actor's close friends on this page.

pagination*object
next_cursor*string

Opaque base64url cursor for the next page; `null` when no further pages.

Example: "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNS0wMVQxMjowMDowMC4wMDBaIiwiaWQiOiJiYmJiIn0"

has_more*boolean

`true` when at least one more page exists. Mirrors `next_cursor !== null`; published as a separate field so SDKs can drive a `while` loop without parsing the cursor. A short or empty `data` array does NOT imply the end of the list when a lane post-filters — always page until this is `false`.

Example: true

Example

Request

GET https://social.productcraft.co/v1/communities/{community_id}/actors/{actor_id}/close-friends
Authorization: Bearer YOUR_TOKEN

Response

{
  "data": [
    {
      "owner_actor_id": "aaaaaaaa-0000-0000-0000-000000000001",
      "member_actor_id": "aaaaaaaa-0000-0000-0000-000000000002",
      "member_external_id": "bob",
      "member_display_name": "Bob",
      "member_avatar_url": "https://...",
      "created_at": "2026-05-01T11:00:00.000Z"
    }
  ],
  "pagination": {
    "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNS0wMVQxMjowMDowMC4wMDBaIiwiaWQiOiJiYmJiIn0",
    "has_more": true
  }
}