Get account field definitions
client.Account.Definitions(ctx, query) (*AccountDefinitionsResponse, error)
GET/v1/accounts/definitions
Returns the schema for all field and relationship definitions available on accounts, including both system-defined and custom fields. Useful for understanding the shape of account data before creating or updating records. See Fields and relationships for more details.
Required scope: accounts:read
Rate limit category: Read
Get account field definitions
package main
import (
"context"
"fmt"
"github.com/Lightfld/lightfield-go"
"github.com/Lightfld/lightfield-go/option"
)
func main() {
client := githubcomlightfldlightfieldgo.NewClient(
option.WithAPIKey("My API Key"),
)
accountDefinitionsResponse, err := client.Account.Definitions(context.TODO(), githubcomlightfldlightfieldgo.AccountDefinitionsParams{
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", accountDefinitionsResponse.FieldDefinitions)
}
{
"fieldDefinitions": {
"foo": {
"archived": true,
"archivedAt": "2019-12-27T18:11:19.117Z",
"description": "description",
"label": "label",
"typeConfiguration": {
"currency": "currency",
"decimalPlaces": -9007199254740991,
"handleService": "TWITTER",
"multipleValues": true,
"options": [
{
"id": "id",
"label": "label",
"category": "ACTIVE",
"color": "RED",
"description": "description",
"forecastPercentage": 0,
"icon": "BACKLOG",
"parentId": "parentId"
}
],
"parentFieldKey": "parentFieldKey",
"unique": true
},
"valueType": "ADDRESS",
"id": "id",
"aiFillable": "ON",
"aiFillablePrompt": "aiFillablePrompt",
"formula": "formula",
"readOnly": true,
"valueSource": "MANUAL"
}
},
"objectType": "objectType",
"relationshipDefinitions": {
"foo": {
"archived": true,
"archivedAt": "2019-12-27T18:11:19.117Z",
"cardinality": "HAS_ONE",
"description": "description",
"label": "label",
"objectType": "objectType",
"id": "id",
"directions": {
"asDestination": {
"cardinality": "HAS_ONE",
"label": "label"
},
"asSource": {
"cardinality": "HAS_ONE",
"label": "label"
}
},
"groupKey": "groupKey",
"inverse": {
"cardinality": "HAS_ONE",
"label": "label"
}
}
},
"relationshipGroupDefinitions": {
"foo": {
"id": "id",
"archived": true,
"archivedAt": "2019-12-27T18:11:19.117Z",
"inverse": {
"label": "label"
},
"label": "label",
"objectType": "objectType"
}
}
}Returns Examples
{
"fieldDefinitions": {
"foo": {
"archived": true,
"archivedAt": "2019-12-27T18:11:19.117Z",
"description": "description",
"label": "label",
"typeConfiguration": {
"currency": "currency",
"decimalPlaces": -9007199254740991,
"handleService": "TWITTER",
"multipleValues": true,
"options": [
{
"id": "id",
"label": "label",
"category": "ACTIVE",
"color": "RED",
"description": "description",
"forecastPercentage": 0,
"icon": "BACKLOG",
"parentId": "parentId"
}
],
"parentFieldKey": "parentFieldKey",
"unique": true
},
"valueType": "ADDRESS",
"id": "id",
"aiFillable": "ON",
"aiFillablePrompt": "aiFillablePrompt",
"formula": "formula",
"readOnly": true,
"valueSource": "MANUAL"
}
},
"objectType": "objectType",
"relationshipDefinitions": {
"foo": {
"archived": true,
"archivedAt": "2019-12-27T18:11:19.117Z",
"cardinality": "HAS_ONE",
"description": "description",
"label": "label",
"objectType": "objectType",
"id": "id",
"directions": {
"asDestination": {
"cardinality": "HAS_ONE",
"label": "label"
},
"asSource": {
"cardinality": "HAS_ONE",
"label": "label"
}
},
"groupKey": "groupKey",
"inverse": {
"cardinality": "HAS_ONE",
"label": "label"
}
}
},
"relationshipGroupDefinitions": {
"foo": {
"id": "id",
"archived": true,
"archivedAt": "2019-12-27T18:11:19.117Z",
"inverse": {
"label": "label"
},
"label": "label",
"objectType": "objectType"
}
}
}