Get table column config

curl --request GET \
  --url https://b.anny.co/api/v1/ui/admin/table-config/{entityType} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://b.anny.co/api/v1/ui/admin/table-config/{entityType}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://b.anny.co/api/v1/ui/admin/table-config/{entityType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://b.anny.co/api/v1/ui/admin/table-config/{entityType}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://b.anny.co/api/v1/ui/admin/table-config/{entityType}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://b.anny.co/api/v1/ui/admin/table-config/{entityType}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "entityType": "customers",
  "columns": [
    {
      "key": "givenName",
      "header": "First name",
      "sortable": true,
      "defaultVisible": true,
      "group": "customer",
      "cell": {
        "type": "text"
      }
    },
    {
      "key": "company",
      "header": "Company",
      "sortable": true,
      "defaultVisible": true,
      "group": "customer",
      "icon": [
        "far",
        "building"
      ],
      "cell": {
        "type": "icon",
        "source": "companyDisplay"
      }
    },
    {
      "key": "communities",
      "header": "Communities",
      "sortable": false,
      "cell": {
        "type": "custom"
      }
    },
    {
      "key": "createdAt",
      "header": "Created at",
      "type": "date",
      "sortable": true,
      "defaultVisible": true,
      "cell": {
        "type": "date"
      }
    },
    {
      "key": "customField.7b2c1e34-9a1d-4c2f-8e5a-1f0b9d2c3a4e",
      "header": "T-shirt size",
      "sortable": false,
      "group": "customField",
      "icon": [
        "far",
        "pen-field"
      ],
      "cell": {
        "type": "customField",
        "source": "customEntryMap.7b2c1e34-9a1d-4c2f-8e5a-1f0b9d2c3a4e"
      }
    }
  ]
}

Personalization

Get table column config

Server-driven column catalog for an admin table: which columns the entity has, how to render each cell, and how to sort or inline-edit it. The client renders exactly the columns returned.

The response varies by:

organization — columns can be gated on the org’s feature flags (for example the check-in, test-result and queue columns), so never assume a fixed column set;
locale — headers are returned in the authenticated user’s language.

This endpoint returns only the column config, not the rows. Fetch the row data from the entity’s own JSON:API resource collection (the resource type matches entityType, except queue-ticket-bookings, which reads from bookings), and save inline edits by PATCHing that resource. See the “Table Configuration” guide for the full cell-type and inline-edit contract.

GET

api

admin

table-config

{entityType}

Get table column config

curl --request GET \
  --url https://b.anny.co/api/v1/ui/admin/table-config/{entityType} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://b.anny.co/api/v1/ui/admin/table-config/{entityType}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://b.anny.co/api/v1/ui/admin/table-config/{entityType}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://b.anny.co/api/v1/ui/admin/table-config/{entityType}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://b.anny.co/api/v1/ui/admin/table-config/{entityType}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://b.anny.co/api/v1/ui/admin/table-config/{entityType}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "entityType": "customers",
  "columns": [
    {
      "key": "givenName",
      "header": "First name",
      "sortable": true,
      "defaultVisible": true,
      "group": "customer",
      "cell": {
        "type": "text"
      }
    },
    {
      "key": "company",
      "header": "Company",
      "sortable": true,
      "defaultVisible": true,
      "group": "customer",
      "icon": [
        "far",
        "building"
      ],
      "cell": {
        "type": "icon",
        "source": "companyDisplay"
      }
    },
    {
      "key": "communities",
      "header": "Communities",
      "sortable": false,
      "cell": {
        "type": "custom"
      }
    },
    {
      "key": "createdAt",
      "header": "Created at",
      "type": "date",
      "sortable": true,
      "defaultVisible": true,
      "cell": {
        "type": "date"
      }
    },
    {
      "key": "customField.7b2c1e34-9a1d-4c2f-8e5a-1f0b9d2c3a4e",
      "header": "T-shirt size",
      "sortable": false,
      "group": "customField",
      "icon": [
        "far",
        "pen-field"
      ],
      "cell": {
        "type": "customField",
        "source": "customEntryMap.7b2c1e34-9a1d-4c2f-8e5a-1f0b9d2c3a4e"
      }
    }
  ]
}

Autorisierungen

Authorization

string

header

erforderlich

The access token received from the authorization server in the OAuth 2.0 flow.

Header

Authorization

string

erforderlich

Bearer Token

Pfadparameter

entityType

enum<string>

erforderlich

The entity whose column catalog to return.

Verfügbare Optionen:

booking-passes,

bookings,

businesses,

communities,

customers,

invoices,

orders,

plan-subscriptions,

queue-ticket-bookings,

resources,

services,

vouchers

Abfrageparameter

string

Organization ID

Antwort

entityType

string

Echoes the requested entity type.

columns

Table Column · object[]

Columns in display order.

Show child attributes

Guides

Customer API

Admin API

Data models

Customer internal API

Admin internal API

Identity API

Additional internal API

Get table column config

Autorisierungen

Header

Pfadparameter

Abfrageparameter

Antwort