List all Entity Keywords

URL

GET https://<tenant>.bubbleppm.com/api/v3/entities/<entity_id>/keywords/

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

External Refs

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

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

Attributes

Name	Type
`id`	PK<EntityKeyword>
`name`	string
`external_ref`	ERef<Keyword>
`keyword_id`	PK<Keyword>
`entity_id`	PK<Entity>
`group`	Object<KeywordGroup>

Filter Parameters

API Requests | Search-&-Parameters

Name	Type
`created_at_lte`	Date `YYYY-MM-DD`
`created_at_gte`	Date `YYYY-MM-DD`
`created_at`	Date `YYYY-MM-DD`
`updated_at_lte`	Date `YYYY-MM-DD`
`updated_at_gte`	Date `YYYY-MM-DD`
`updated_at`	Date `YYYY-MM-DD`
`group_id`	Integer

Example Response

CODE

[
  {
    "id": 1,
    "external_ref": "KW_1",
    "name": "Green",
    "keyword_id": 1,
    "entity_id": 51,
    "group": {
      "id": 1,
      "external_ref": "GR_2",
      "name": "Risk Status"
  },
  {
    "id": 1,
    "external_ref": "KW_12",
    "name": "United Kingdom",
    "entity_id": 51,
    "keyword_id": 20,
    "group": {
      "id": 2,
      "external_ref": "GR_2",
      "name": "Country"
  }
]

URL

External Refs

Pagination

Attributes

Filter Parameters

Example Response