v1
latestOpenAPI 3.1.02026-07-223614164.6 KBGroups
List group custom fields
Returns a list of group custom fields for an entity type.
get/v1/groups/{groupId}/custom-fields/{entityType}
Path parameters
groupIdstring required
The identifier of the group. You can retrieve a list of group identifiers using the /v1/groups endpoint.
entityTypestring required
The entity type the custom fields belong to. It can be person, company, or a custom object name.
Query parameters
limitinteger
The number of items to return.
cursorstring
A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.
Response
A paginated list of group custom fields for an entity type. The data.items field contains the list of group custom fields, and the data.pagination.nextLink field contains a link to the next page of results, if available.
Example response
{
"data": {
"items": [
{
"name": "Status",
"type": "singleSelect",
"options": [
{
"label": "Active",
"color": "#ffffff"
},
{
"label": "Inactive",
"color": "#000000"
}
]
},
{
"name": "Total Revenue",
"type": "numericField",
"config": {
"format": "currency",
"currency": "USD"
}
},
{
"name": "Details",
"type": "textField"
},
{
"name": "Tags",
"type": "multipleSelect",
"options": [
{
"label": "Tag 1",
"color": "#ffffff"
},
{
"label": "Tag 2",
"color": "#000000"
}
]
},
{
"name": "Relationships",
"type": "contactField"
},
{
"name": "Date",
"type": "dateField"
},
{
"name": "Assigned to",
"type": "userField"
},
{
"name": "Deals",
"type": "objectField"
}
],
"pagination": {
"nextLink": "https://api.folk.app/v1/groups/grp_bc984b3f-0386-434d-82d7-a91eb6badd71/custom-fields/person?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
}
},
"deprecations": [
"This field is deprecated"
]
}