Sign in
Button

List

Retrieve a paginated list of Button records. Supports filtering, sorting, and search.

get/api/cp/button

Query parameters

typestring

Filter by Type

open_mode'page' | 'dialog'

Filter by Open Mode

Response

Successful response

idinteger

Id

account_idinteger

Account Id

company_idinteger

Company Id

app_idstring

App Id

anvil_pathstring

Anvil Path

labelstring

Label

iconstring

Icon

tooltipstring

Tooltip

typestring

Type

areastring

Area

placementstring

Placement

min_selectinteger

Min Select

max_selectinteger

Max Select

sandbox_idinteger

Sandbox Id

fnstring

Fn

form_idinteger

Form Id

page_idstring

Page Id

sort_orderinteger

Sort Order

company_idsstring

Company Ids

open_mode'page' | 'dialog'

Open Mode

Example response

[
  {
    "id": 12345,
    "account_id": 1,
    "company_id": 1,
    "app_id": 1,
    "anvil_path": "example_anvil_path",
    "label": "example_label",
    "icon": "example_icon",
    "tooltip": "example_tooltip",
    "type": "example_type",
    "area": "example_area",
    "placement": "example_placement",
    "min_select": 123,
    "max_select": 123,
    "sandbox_id": 1,
    "fn": "example_fn",
    "form_id": 1,
    "page_id": 1,
    "sort_order": 1,
    "company_ids": "example_company_ids",
    "open_mode": "page"
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.