List all Entities

URL

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

This endpoint has pagination enabled per the description on the pagination documentation.

External Refs

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

Attributes

Name	Type	Default
`id`	PK<Entity>
`external_ref`	ERef<Entity>
`name`	String
`type`	Object<EntityType>
`model`	Object<EntityModel>
`init_start_date`	DateTime
`archived`	Boolean	`False`
`published`	Boolean	`False`
`template`	Boolean	`False`
`created_at`	DateTime
`updated_at`	DateTime
`lifecycle_state`	Object<EntityLifecycleState>
`code`	String

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`
`name`	String

Example Response

CODE

[
  {
    "id": 1,
    "name": "A new project",
    "type": {
        "id": 1,
        "name": "Product"
    },
    "model": {
        "id": 1,
        "name": "Product",
        "icon": "circle",
        "color": "#55C1E8"
    },
    "init_start_date": "2023-03-20",
    "created_at": "2023-03-20T10:13:24.330367Z",
    "updated_at": "2023-03-202T17:41:13.902151Z",
    "archived": false,
    "published": true,
    "template": false,
    "lifecycle_state": {
        "id": 2,
        "name": "Active",
        "icon": "play-circle-outline",
        "color": "#035980"
    },
    "code": "ABC123",
    "external_ref": "ABC123"
  },
  {
    "id": 2,
    "name": "A newer project",
    "type": {
        "id": 1,
        "name": "Product"
    },
    "model": {
        "id": 1,
        "name": "Product",
        "icon": "circle",
        "color": "#55C1E8"
    },
    "init_start_date": "2023-03-20",
    "created_at": "2023-03-20T10:13:24.330367Z",
    "updated_at": "2023-03-202T17:41:13.902151Z",
    "archived": false,
    "published": true,
    "template": false,
    "lifecycle_state": {
        "id": 2,
        "name": "Active",
        "icon": "play-circle-outline",
        "color": "#035980"
    },
    "code": "DEF456",
    "external_ref": "DEF456"
  }
  
]

URL

Pagination

External Refs

Attributes

Filter Parameters

Example Response