Skip to main content
GET
Get a project

Headers

x-project-id
string
required

Project ID to specify the project context

Path Parameters

id
string
required

Unique identifier of the project to retrieve.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

id
string
required

Unique identifier for the project

Example:

"01234567-89ab-cdef-0123-456789abcdef"

name
string
required

Name of the project

Example:

"My Project"

organisation
object
required

Organisation that owns this project

Example:

"01234567-89ab-cdef-0123-456789abcdef"

updatedAt
string<date-time>
required

Last update timestamp

Example:

"2021-01-01T00:00:00.000Z"

slug
string

Slug of the project

Example:

"my-project"

description
string

Description of the project

Example:

"My Project Description"

industry
string

Industry of the project

Example:

"Technology"

website
string

Website of the project

Example:

"https://www.mentionlab.io"

nameAliases
string[]

Name aliases of the project

Example:
blackListAliases
string[]

Blacklist aliases of the project

Example:
currentPo
string

Active purchase order reference for this project.

Example:

"PO-2026-Q2-1234"

themeAnalysisEnabled
boolean

Whether the async Brand Perception & Intelligence theme-analysis batch is enabled for this project.

Example:

false

themeLanguage
string

Theme language for this project: a language code forces a monolingual taxonomy, 'auto' follows each answer.

Example:

"en"

themeClusteringConfig
object

Advanced per-project theme-clustering threshold overrides; absent knobs use the defaults.

settings
object

Free-form per-project settings owned by the frontend (e.g. saved custom filters).