Skip to main content
GET
/
api
/
public
/
teams
/
directory
/
meta
{
  "Meta": {},
  "Meta.DirectoryEnabled": true,
  "Meta.DirectoryContents": {},
  "Meta.DirectoryRecords": {},
  "Meta.OnlyInvoicingSpace": true,
  "Meta.ShowCheckInMembers": true,
  "Meta.Tags": [
    {}
  ],
  "Meta.Tags[].Tag": "<string>",
  "Meta.Tags[].Count": 123,
  "Meta.Tags[].Percentage": 123,
  "Meta.CustomFields": [
    {}
  ],
  "Meta.CustomFields[].Id": 123,
  "Meta.CustomFields[].Name": "<string>",
  "Meta.CustomFields[].FieldType": "<string>",
  "Meta.CustomFields[].CustomFieldIndex": 123,
  "Meta.CustomFields[].DisplayInDirectorySearch": true,
  "Meta.CustomFields[].NameInSearch": "<string>",
  "Meta.CustomFields[].AvailableOptions": [
    "<string>"
  ],
  "401 Unauthorized": {}
}

​
Get Directory Meta

Returns metadata that controls how the community directory behaves — including whether the directory is enabled, what content it shows (teams only, members only, or both), the tag cloud for filtering, and any custom fields configured for directory search.

​
Authentication

Requires a valid customer bearer token.

​
Response

​
Meta
DirectoryMeta
required
The directory metadata object.

​
Meta Fields

​
Meta.DirectoryEnabled
boolean
When true, the community directory is enabled for this location.
​
Meta.DirectoryContents
eDirectoryContents
Controls which profiles appear in the directory: 1 = Published profiles, 2 = Published profiles with a price plan, 3 = Everyone, 4 = Everyone with a price plan.
​
Meta.DirectoryRecords
eDirectoryRecordType
Controls the record types shown: 1 = Teams and members, 2 = Only teams, 3 = Only members.
​
Meta.OnlyInvoicingSpace
boolean
When true, only members from the invoicing space are shown.
​
Meta.ShowCheckInMembers
boolean
When true, members who are currently checked in are highlighted.
​
Meta.Tags
TagCloud[]
Tag cloud entries derived from all published profiles.
​
Meta.Tags[].Tag
string
The tag text.
​
Meta.Tags[].Count
number
Number of profiles using this tag.
​
Meta.Tags[].Percentage
number
Relative weight of this tag as a percentage — used to size tags in a tag cloud UI.
​
Meta.CustomFields
CustomField[]
Custom fields configured for directory search.
​
Meta.CustomFields[].Id
number
Unique identifier of the custom field.
​
Meta.CustomFields[].Name
string
Display name of the custom field.
​
Meta.CustomFields[].FieldType
string
Field type (e.g., "Text", "Dropdown").
​
Meta.CustomFields[].CustomFieldIndex
number
Index used to map the field to the correct slot.
​
Meta.CustomFields[].DisplayInDirectorySearch
boolean
When true, this field appears as a search filter in the directory UI.
​
Meta.CustomFields[].NameInSearch
string
Label shown in the search filter UI.
​
Meta.CustomFields[].AvailableOptions
string[]
Available values for dropdown-type fields.

​
Examples

​
Fetch directory metadata

GET /api/public/teams/directory/meta
Authorization: Bearer {token}

{
  "Meta": {
    "DirectoryEnabled": true,
    "DirectoryContents": 1,
    "DirectoryRecords": 1,
    "OnlyInvoicingSpace": false,
    "ShowCheckInMembers": true,
    "Tags": [
      { "Tag": "technology", "Count": 8, "Percentage": 40 },
      { "Tag": "design", "Count": 5, "Percentage": 25 },
      { "Tag": "marketing", "Count": 4, "Percentage": 20 }
    ],
    "CustomFields": [
      {
        "Id": 1,
        "Name": "Industry",
        "FieldType": "Dropdown",
        "CustomFieldIndex": 0,
        "DisplayInDirectorySearch": true,
        "NameInSearch": "Industry",
        "AvailableOptions": ["Technology", "Finance", "Design", "Marketing"]
      }
    ]
  }
}

​
TypeScript Integration

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

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

​
Usage in Portal

ContextSource file
Community directory (/community/directory)src/views/community/directory/components/useDirectoryData.ts

​
Error Responses

​
401 Unauthorized
error
The customer is not authenticated or the session has expired.
MethodEndpointDescription
GET/api/public/teams/publishedList published teams in the directory
GET/api/public/teams/published/{teamId}Get a single published team profile
GET/api/public/teams/myList the customer’s own teams