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": "Kommercielt segment, der bruges til rapportering.",
"fieldType": "SINGLE_SELECT",
"isRequired": false,
"key": "account_tier",
"label": "Kontoniveau",
"options": [
{
"color": "green",
"label": "Vækst",
"value": "growth"
},
{
"color": "blue",
"label": "Enterprise",
"value": "enterprise"
}
],
"position": 0
}
],
"nextCursor": null
}{
"error": {
"code": "INVALID_INPUT",
"message": "Kaldet indeholder ugyldige værdier.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "En gyldig bearer-adgangsoplysning er påkrævet.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Adgangsoplysningen giver ikke adgang til denne handling.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Ressourcen blev ikke fundet.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "For mange kald. Prøv igen om lidt.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Der opstod en uventet fejl.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}Brugerdefinerede felter
Hent definitioner af brugerdefinerede felter
Hent aktive offentlige definitioner af brugerdefinerede felter til virksomheder eller personer.
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": "Kommercielt segment, der bruges til rapportering.",
"fieldType": "SINGLE_SELECT",
"isRequired": false,
"key": "account_tier",
"label": "Kontoniveau",
"options": [
{
"color": "green",
"label": "Vækst",
"value": "growth"
},
{
"color": "blue",
"label": "Enterprise",
"value": "enterprise"
}
],
"position": 0
}
],
"nextCursor": null
}{
"error": {
"code": "INVALID_INPUT",
"message": "Kaldet indeholder ugyldige værdier.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "En gyldig bearer-adgangsoplysning er påkrævet.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Adgangsoplysningen giver ikke adgang til denne handling.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Ressourcen blev ikke fundet.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "For mange kald. Prøv igen om lidt.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Der opstod en uventet fejl.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}Autorisationer
Godkend med en personlig Floral-adgangsnøgle, der er bundet til ét arbejdsområde.
Overskrifter
Valgfrit korrelations-id fra kalderen. Floral returnerer den anvendte værdi i X-Request-ID.
Required string length:
1 - 128Sti-parametre
Slug for det arbejdsområde, adgangsoplysningen er bundet til.
Required string length:
1 - 100Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Forespørgselsparametre
Uigennemsigtig cursor returneret som nextCursor af den forrige side. Undersøg eller konstruér den ikke.
Maximum string length:
512Ressourcetype, hvis aktive definitioner returneres.
Tilgængelige muligheder:
COMPANY, PERSON Antal elementer, der skal returneres.
Nødvendigt interval:
1 <= x <= 50