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

# Get Directory Meta

> Retrieve directory configuration and the tag cloud for the customer member directory.

# 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

<ParamField query="_shape" type="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.
</ParamField>

## Response

<ResponseField name="Meta.DirectoryEnabled" type="boolean">
  `true` when the member directory feature is active for this location. When `false`, the directory page should not be rendered.
</ResponseField>

<ResponseField name="Meta.DirectoryContents" type="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
</ResponseField>

<ResponseField name="Meta.DirectoryRecords" type="number">
  Controls what record types appear: - `1` — Teams and individual members - `2` — Teams only - `3` — Individual members only
</ResponseField>

<ResponseField name="Meta.OnlyInvoicingSpace" type="boolean">
  When `true`, only customers invoiced at the current location are shown in the directory.
</ResponseField>

<ResponseField name="Meta.ShowCheckInMembers" type="boolean">
  When `true`, customers who are currently checked in are highlighted in the directory.
</ResponseField>

<ResponseField name="Meta.Tags" type="array">
  Tag cloud used to populate the directory filter sidebar. Each entry represents a tag and its relative frequency.
</ResponseField>

<ResponseField name="Meta.Tags[].Tag" type="string">
  The tag string value (matches entries in `Coworker.ProfileTagsList`).
</ResponseField>

<ResponseField name="Meta.Tags[].Count" type="number">
  Number of published profiles that have this tag.
</ResponseField>

<ResponseField name="Meta.Tags[].Percentage" type="number">
  This tag's share of total tagged profiles, as a percentage (0–100).
</ResponseField>

## Example Response

```json theme={null}
{
  "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

```typescript theme={null}
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

| Context                                               | Source file                                                    |
| ----------------------------------------------------- | -------------------------------------------------------------- |
| Member directory page — tag cloud filter and settings | `src/views/community/directory/components/useDirectoryData.ts` |

## Error Responses

<ResponseField name="401 Unauthorized" type="error">
  The bearer token is missing, expired, or invalid.
</ResponseField>

## Related Endpoints

| Method | Endpoint                           | Description                                    |
| ------ | ---------------------------------- | ---------------------------------------------- |
| `GET`  | `/api/public/coworkers/published`  | List published profiles in the directory       |
| `GET`  | `/api/public/teams/directory/meta` | Get the equivalent meta for the team directory |