Search fields
curl --request POST \
--url https://public-api.sessionboard.com/v1/event/{eventId}/fields \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"filters": {
"createdAt": {
"before": "2023-11-07T05:31:56Z",
"after": "2023-11-07T05:31:56Z"
},
"updatedAt": {
"before": "2023-11-07T05:31:56Z",
"after": "2023-11-07T05:31:56Z"
}
},
"sort": {},
"expand": [
"<string>"
]
}
'import requests
url = "https://public-api.sessionboard.com/v1/event/{eventId}/fields"
payload = {
"filters": {
"createdAt": {
"before": "2023-11-07T05:31:56Z",
"after": "2023-11-07T05:31:56Z"
},
"updatedAt": {
"before": "2023-11-07T05:31:56Z",
"after": "2023-11-07T05:31:56Z"
}
},
"sort": {},
"expand": ["<string>"]
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filters: {
createdAt: {before: '2023-11-07T05:31:56Z', after: '2023-11-07T05:31:56Z'},
updatedAt: {before: '2023-11-07T05:31:56Z', after: '2023-11-07T05:31:56Z'}
},
sort: {},
expand: ['<string>']
})
};
fetch('https://public-api.sessionboard.com/v1/event/{eventId}/fields', 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://public-api.sessionboard.com/v1/event/{eventId}/fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
'createdAt' => [
'before' => '2023-11-07T05:31:56Z',
'after' => '2023-11-07T05:31:56Z'
],
'updatedAt' => [
'before' => '2023-11-07T05:31:56Z',
'after' => '2023-11-07T05:31:56Z'
]
],
'sort' => [
],
'expand' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public-api.sessionboard.com/v1/event/{eventId}/fields"
payload := strings.NewReader("{\n \"filters\": {\n \"createdAt\": {\n \"before\": \"2023-11-07T05:31:56Z\",\n \"after\": \"2023-11-07T05:31:56Z\"\n },\n \"updatedAt\": {\n \"before\": \"2023-11-07T05:31:56Z\",\n \"after\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"sort\": {},\n \"expand\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public-api.sessionboard.com/v1/event/{eventId}/fields")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"createdAt\": {\n \"before\": \"2023-11-07T05:31:56Z\",\n \"after\": \"2023-11-07T05:31:56Z\"\n },\n \"updatedAt\": {\n \"before\": \"2023-11-07T05:31:56Z\",\n \"after\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"sort\": {},\n \"expand\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.sessionboard.com/v1/event/{eventId}/fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"createdAt\": {\n \"before\": \"2023-11-07T05:31:56Z\",\n \"after\": \"2023-11-07T05:31:56Z\"\n },\n \"updatedAt\": {\n \"before\": \"2023-11-07T05:31:56Z\",\n \"after\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"sort\": {},\n \"expand\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "<string>",
"internal_name": "<string>",
"public_name": "<string>",
"field_type": "<string>",
"field_source": "<string>",
"contains_pii": true,
"scope": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"pagination": {
"currentPage": 123,
"pageSize": 123,
"totalPages": 123,
"totalResults": 123
}
}Event — Custom Fields
Search fields
Search and filter field definitions for an event, including standard and custom fields.
POST
/
v1
/
event
/
{eventId}
/
fields
Search fields
curl --request POST \
--url https://public-api.sessionboard.com/v1/event/{eventId}/fields \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"filters": {
"createdAt": {
"before": "2023-11-07T05:31:56Z",
"after": "2023-11-07T05:31:56Z"
},
"updatedAt": {
"before": "2023-11-07T05:31:56Z",
"after": "2023-11-07T05:31:56Z"
}
},
"sort": {},
"expand": [
"<string>"
]
}
'import requests
url = "https://public-api.sessionboard.com/v1/event/{eventId}/fields"
payload = {
"filters": {
"createdAt": {
"before": "2023-11-07T05:31:56Z",
"after": "2023-11-07T05:31:56Z"
},
"updatedAt": {
"before": "2023-11-07T05:31:56Z",
"after": "2023-11-07T05:31:56Z"
}
},
"sort": {},
"expand": ["<string>"]
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
filters: {
createdAt: {before: '2023-11-07T05:31:56Z', after: '2023-11-07T05:31:56Z'},
updatedAt: {before: '2023-11-07T05:31:56Z', after: '2023-11-07T05:31:56Z'}
},
sort: {},
expand: ['<string>']
})
};
fetch('https://public-api.sessionboard.com/v1/event/{eventId}/fields', 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://public-api.sessionboard.com/v1/event/{eventId}/fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
'createdAt' => [
'before' => '2023-11-07T05:31:56Z',
'after' => '2023-11-07T05:31:56Z'
],
'updatedAt' => [
'before' => '2023-11-07T05:31:56Z',
'after' => '2023-11-07T05:31:56Z'
]
],
'sort' => [
],
'expand' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public-api.sessionboard.com/v1/event/{eventId}/fields"
payload := strings.NewReader("{\n \"filters\": {\n \"createdAt\": {\n \"before\": \"2023-11-07T05:31:56Z\",\n \"after\": \"2023-11-07T05:31:56Z\"\n },\n \"updatedAt\": {\n \"before\": \"2023-11-07T05:31:56Z\",\n \"after\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"sort\": {},\n \"expand\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public-api.sessionboard.com/v1/event/{eventId}/fields")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"createdAt\": {\n \"before\": \"2023-11-07T05:31:56Z\",\n \"after\": \"2023-11-07T05:31:56Z\"\n },\n \"updatedAt\": {\n \"before\": \"2023-11-07T05:31:56Z\",\n \"after\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"sort\": {},\n \"expand\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.sessionboard.com/v1/event/{eventId}/fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"createdAt\": {\n \"before\": \"2023-11-07T05:31:56Z\",\n \"after\": \"2023-11-07T05:31:56Z\"\n },\n \"updatedAt\": {\n \"before\": \"2023-11-07T05:31:56Z\",\n \"after\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"sort\": {},\n \"expand\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "<string>",
"internal_name": "<string>",
"public_name": "<string>",
"field_type": "<string>",
"field_source": "<string>",
"contains_pii": true,
"scope": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"pagination": {
"currentPage": 123,
"pageSize": 123,
"totalPages": 123,
"totalResults": 123
}
}Authorizations
ApiKeyBearerToken
Organization API token. Generate from Organization Settings → API Tokens.
Path Parameters
The event ID.
Query Parameters
Page number for pagination.
Required range:
1 <= x <= 999Number of results per page.
Required range:
1 <= x <= 100Body
application/json
⌘I

