---
title: "List company custom field groups"
method: GET
path: "/admin/company_custom_field_groups"
tags: ["Company custom field groups"]
---

# List company custom field groups

`GET /admin/company_custom_field_groups`

## Request

- Base URL: `https://api.pipelinecrm.com/api/v3`
- URL: `https://api.pipelinecrm.com/api/v3/admin/company_custom_field_groups`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer and API key in header `app-key`
  - API key in query parameter `api_key` and API key in query parameter `app_key`

## Response `200`

Successful Response

- CustomFieldGroupList
  - `pagination` Pagination, required: Paging details returned alongside `entries` on every paginated list.
    - `page` integer: The page returned. Request another with `?page=N`.
    - `per_page` integer: Page size. `?per_page=N`, capped at 200.
    - `total` integer: Total number of records matching the request across all pages.
    - `pages` integer: Number of pages at this `per_page`.
    - `total_in_account` integer, nullable: Total number of records of this type visible to you before filters were applied. Null when not computed for the endpoint.
    - `page_var` string: Name of the query parameter that selects the page. Always `page`.
    - `url` string, nullable: Path of the request, when the endpoint reports it.
  - `entries` CustomFieldGroupAll[], required: Paginated custom field groups
    - `id` integer: Unique identifier
    - `created_at` string: Timestamp when the record was created (time zone in user's time zone).
    - `updated_at` string: Timestamp when the record was last touched (time zone in user's time zone).
    - `type` 'CompanyCustomFieldGroup' | 'DealCustomFieldGroup' | 'PersonCustomFieldGroup' | 'ProjectCustomFieldGroup': Type of custom field group
    - `name` string: Name of the custom field group

## Other responses

- `400`: The request could not be processed as sent (for example a malformed id or an unsupported combination of parameters).

---

[API](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api.md) · [All operations](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/revisions/53ebfcc83597?raw)