Skip to main content
GET
Get a group custom field

Authorizations

Authorization
string
header
required

API key for authentication

Path Parameters

groupId
string
required

The identifier of the group. You can retrieve a list of group identifiers using the /v1/groups endpoint.

Required string length: 40
entityType
string
required

The entity type the custom fields belong to. It can be person, company, or a custom object name.

Maximum string length: 500
customFieldName
string
required

The custom field name to retrieve.

Maximum string length: 500

Response

The retrieved group custom field.

data
object
required

A group custom field.

Example:
deprecations
string[]
Example: