Bubble PPM API Documentation

Retrieve a single Entity Keyword

URL

GET https://<tenant>.bubbleppm.com/api/v3/entities/<entity_id>/keywords/<keyword_id>/
GET https://<tenant>.bubbleppm.com/api/v3/entities/<entity_external_ref>/keywords/<keyword_external_ref>/?use_external_refs

External Refs

This endpoint supports External Refs. For more information please refer to the documentation here.

Attributes

Name

Type

id

PK<EntityKeyword>

keyword_id

PK<Keyword>

entity_id

PK<Entity>

external_ref

ERef<Keyword>

name

string

group

Object<KeywordGroup>

Example Response

{
  "id": 1,
  "keyword_id": 1,
  "entity_id": 51,
  "external_ref": "KW_1",
  "name": "Green",
  "group": {
    "id": 1,
    "name": "Risk Status"
  }
}