Skip to main content
GET
List group custom fields

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

Query Parameters

limit
integer
default:20

The number of items to return.

Required range: 1 <= x <= 100
cursor
string

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.

Maximum string length: 512

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.

data
object
required
Example:
deprecations
string[]
Example: