cURL
curl --request GET \
--url 'https://app.floral.so/api/v1/workspaces/acme-nordic/custom-field-definitions?entityType=COMPANY&limit=20' \
--header 'Authorization: Bearer $FLORAL_TOKEN'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.floral.so/api/v1/workspaces/{workspaceSlug}/custom-field-definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"items": [
{
"config": {},
"description": "Commercial segment used for reporting.",
"fieldType": "SINGLE_SELECT",
"isRequired": false,
"key": "account_tier",
"label": "Account tier",
"options": [
{
"color": "green",
"label": "Growth",
"value": "growth"
},
{
"color": "blue",
"label": "Enterprise",
"value": "enterprise"
}
],
"position": 0
}
],
"nextCursor": null
}{
"error": {
"code": "INVALID_INPUT",
"message": "The request contains invalid values.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "A valid bearer credential is required.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "The credential does not grant this operation.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "The resource was not found.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests. Retry shortly.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}Custom fields
List custom-field definitions
List active public custom-field definitions for companies or people.
GET
https://app.floral.so
/
api
/
v1
/
workspaces
/
{workspaceSlug}
/
custom-field-definitions
cURL
curl --request GET \
--url 'https://app.floral.so/api/v1/workspaces/acme-nordic/custom-field-definitions?entityType=COMPANY&limit=20' \
--header 'Authorization: Bearer $FLORAL_TOKEN'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.floral.so/api/v1/workspaces/{workspaceSlug}/custom-field-definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"items": [
{
"config": {},
"description": "Commercial segment used for reporting.",
"fieldType": "SINGLE_SELECT",
"isRequired": false,
"key": "account_tier",
"label": "Account tier",
"options": [
{
"color": "green",
"label": "Growth",
"value": "growth"
},
{
"color": "blue",
"label": "Enterprise",
"value": "enterprise"
}
],
"position": 0
}
],
"nextCursor": null
}{
"error": {
"code": "INVALID_INPUT",
"message": "The request contains invalid values.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "A valid bearer credential is required.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "The credential does not grant this operation.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "The resource was not found.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests. Retry shortly.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}Authorizations
Authenticate with a workspace-pinned Floral personal access token.
Headers
Optional caller-generated correlation ID. Floral returns the effective value in X-Request-ID.
Required string length:
1 - 128Path Parameters
Slug of the workspace pinned to the credential.
Required string length:
1 - 100Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Query Parameters
Opaque cursor returned as nextCursor by the previous page. Do not inspect or construct it.
Maximum string length:
512Resource type whose active definitions are returned.
Available options:
COMPANY, PERSON Number of items to return.
Required range:
1 <= x <= 50