Skip to main content
GET
/
api
/
entities
/
{id}
Get entity by ID
curl --request GET \
  --url https://api.mentionlab.io/api/entities/{id} \
  --header 'x-project-id: <x-project-id>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "isOwned": true,
  "isPrimary": true,
  "isCompetitor": true,
  "isBlacklisted": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "aliases": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "alias": "<string>"
    }
  ],
  "mergedSources": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "slug": "<string>"
    }
  ],
  "group": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>"
  },
  "canonicalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Headers

​
x-project-id
string
required

Project ID to specify the project context

Path Parameters

​
id
string<uuid>
required

The UUID of the entity to retrieve.

Response

​
id
string<uuid>
required
​
name
string
required
​
slug
string
required
​
type
enum<string>
required
Available options:
brand,
person,
company,
other
​
isOwned
boolean
required
​
isPrimary
boolean
required
​
isCompetitor
boolean
required
​
isBlacklisted
boolean
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
aliases
object[]
required

Alternate name strings that resolve to this entity.

​
mergedSources
object[]
required

Separate entities merged into this one (their mentions roll up here; reversible via unmerge).

​
group
object
​
canonicalId
string<uuid>