Skip to main content
GET
/
api
/
public
/
coworkers
/
directory
/
meta
{
  "Meta.DirectoryEnabled": true,
  "Meta.DirectoryContents": 123,
  "Meta.DirectoryRecords": 123,
  "Meta.OnlyInvoicingSpace": true,
  "Meta.ShowCheckInMembers": true,
  "Meta.Tags": [
    {}
  ],
  "Meta.Tags[].Tag": "<string>",
  "Meta.Tags[].Count": 123,
  "Meta.Tags[].Percentage": 123,
  "401 Unauthorized": {}
}

​
Get Directory Meta

Returns configuration settings and tag cloud data for the customer member directory. The portal uses this to determine whether the directory is enabled, what content it shows, and which filter tags to display in the directory sidebar.

​
Authentication

Requires a valid customer bearer token.

​
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

​
Meta.DirectoryEnabled
boolean
true when the member directory feature is active for this location. When false, the directory page should not be rendered.
​
Meta.DirectoryContents
number
Controls whose profiles appear in the directory: - 1 — Published profiles only - 2 — Published profiles with an active plan - 3 — Everyone (all customers) - 4 — Everyone with an active plan
​
Meta.DirectoryRecords
number
Controls what record types appear: - 1 — Teams and individual members - 2 — Teams only - 3 — Individual members only
​
Meta.OnlyInvoicingSpace
boolean
When true, only customers invoiced at the current location are shown in the directory.
​
Meta.ShowCheckInMembers
boolean
When true, customers who are currently checked in are highlighted in the directory.
​
Meta.Tags
array
Tag cloud used to populate the directory filter sidebar. Each entry represents a tag and its relative frequency.
​
Meta.Tags[].Tag
string
The tag string value (matches entries in Coworker.ProfileTagsList).
​
Meta.Tags[].Count
number
Number of published profiles that have this tag.
​
Meta.Tags[].Percentage
number
This tag’s share of total tagged profiles, as a percentage (0–100).

​
Example Response

{
  "Meta": {
    "DirectoryEnabled": true,
    "DirectoryContents": 1,
    "DirectoryRecords": 1,
    "OnlyInvoicingSpace": false,
    "ShowCheckInMembers": true,
    "Tags": [
      { "Tag": "UX", "Count": 12, "Percentage": 24.0 },
      { "Tag": "Design Systems", "Count": 8, "Percentage": 16.0 },
      { "Tag": "Research", "Count": 6, "Percentage": 12.0 }
    ]
  }
}

​
TypeScript Integration

import endpoints from '@/api/endpoints'
import { DirectoryMetaData } from '@/types/endpoints/DirectoryMeta'
import { useData } from '@/api/fetchData'

const { resource: meta } = useData<DirectoryMetaData>(httpClient, endpoints.coworkers.directory.meta)

if (!meta?.Meta.DirectoryEnabled) {
  // Hide the directory navigation item
}

​
Usage in Portal

ContextSource file
Member directory page — tag cloud filter and settingssrc/views/community/directory/components/useDirectoryData.ts

​
Error Responses

​
401 Unauthorized
error
The bearer token is missing, expired, or invalid.
MethodEndpointDescription
GET/api/public/coworkers/publishedList published profiles in the directory
GET/api/public/teams/directory/metaGet the equivalent meta for the team directory