latestOpenAPI 3.1.02026-08-1584337456.5 KB

9dfc2be2007f

Dataframes

Get Dataframes

Authorization scope: dataframe:list

Get all dataframe entities from the DB

get/v1/accounts/{account_id}/environments/{environment_id}/dataframes

Path parameters

account_idstring required

environment_idstring required

Query parameters

items_per_pageinteger

The number of items per page in the paginated list.

pageinteger

The current page number in the paginated list.

Response

Successful Response

next_pagestring nullable

The next page URL

previous_pagestring nullable

The previous page URL

pageinteger

The page number

current_page_sizeinteger required

The current page size

total_itemsinteger

The total number of entities fetched

account_idstring required

The account id

environment_idstring required

The environment id

Example response

{
  "items": [
    {
      "account_id": "62e7f4352c13160013dc39be",
      "environment_id": "82e7f4122c13169813dc395g",
      "name": "unique_name"
    }
  ]
}