Get Related Customer Profiles

Retrieve customer profiles related to a given customer, based on shared tags, location, or other affinity signals.

GET /api/public/coworkers/published/{coworkerId}/related

Get Related Customer Profiles

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/public/coworkers/published/{coworkerId}/related \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "RelatedProfiles": [
    {}
  ],
  "Threads": [
    {}
  ],
  "RelatedProfiles[].Id": 123,
  "RelatedProfiles[].FullName": "<string>",
  "RelatedProfiles[].AvatarUrl": "<string>",
  "RelatedProfiles[].Position": {},
  "RelatedProfiles[].CompanyName": "<string>",
  "RelatedProfiles[].ProfileTagsList": [
    {}
  ],
  "401 Unauthorized": {},
  "404 Not Found": {}
}

Get Related Customer Profiles

Returns a list of customer profiles that are related to the specified customer. Related profiles are surfaced at the bottom of a customer’s directory profile card to encourage discovery and connections within the community.

Authentication

Requires a valid customer bearer token.

Path Parameters

coworkerId · number · required

The numeric identifier of the customer whose related profiles you want to retrieve. Obtain this from GET /api/public/coworkers/published ([].Id).

Query Parameters

_shape · string

Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation.

Response

Returns an object containing related customer profiles and community threads for the specified customer.

RelatedProfiles · Coworker[]

Array of customer profiles related to the specified customer. May be empty if no related profiles are found.

Threads · CommunityThread[]

Array of community threads associated with the specified customer.

Coworker Fields (within RelatedProfiles[])

RelatedProfiles[].Id · number

Unique identifier for the related customer profile.

RelatedProfiles[].FullName · string

Display name of the related customer.

RelatedProfiles[].AvatarUrl · string

URL to the related customer’s avatar image.

RelatedProfiles[].Position · string | null

Job title of the related customer.

RelatedProfiles[].CompanyName · string

Company name of the related customer.

RelatedProfiles[].ProfileTagsList · array

Tags shared between the source customer and the related customer.

Example Response

{
  "RelatedProfiles": [
    {
      "Id": 202,
      "FullName": "Carlos Ruiz",
      "AvatarUrl": "https://nexudushq.spaces.nexudus.com/media/coworker/202/avatar",
      "GuessedFirstName": "Carlos",
      "Position": "UX Researcher",
      "CompanyName": "Ruiz UX Studio",
      "ProfileTagsList": ["UX", "Research"]
    }
  ],
  "Threads": []
}

TypeScript Integration

import endpoints from '@/api/endpoints'
import { Coworker } from '@/types/spaces/Coworker'
import { CommunityThread } from '@/types/spaces/CommunityThread'
import { useData } from '@/api/fetchData'

const url = endpoints.coworkers.directory.related(coworkerId)
// => '/api/public/coworkers/published/101/related'

const { resource: related } = useData<{ RelatedProfiles: Coworker[]; Threads: CommunityThread[] }>(httpClient, url)

Usage in Portal

Context	Source file
Related profiles section in directory profile modal	src/views/community/directory/components/CoworkersDirectoryProfileModal.tsx

Error Responses

401 Unauthorized · error

The bearer token is missing, expired, or invalid.

404 Not Found · error

No published profile with the given coworkerId was found.

Related Endpoints

Method	Endpoint	Description
GET	/api/public/coworkers/published/{coworkerId}	Get the full profile for this customer
GET	/api/public/coworkers/published	List all published profiles in the directory