---
title: "List project custom field labels"
method: GET
path: "/admin/project_custom_field_labels"
tags: ["Project custom field labels"]
---

# List project custom field labels

`GET /admin/project_custom_field_labels`

## Request

- Base URL: `https://api.pipelinecrm.com/api/v3`
- URL: `https://api.pipelinecrm.com/api/v3/admin/project_custom_field_labels`
- 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`

**Filtered request example** — Date-type project custom fields:

```
curl -g -H "Authorization: Bearer pcrm_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  "https://api.pipelinecrm.com/api/v3/admin/project_custom_field_labels.json?conditions[custom_field_label_field_type]=date"
```

## Query parameters

- `conditions` CustomFieldLabelConditions
  - `custom_field_label_name` string: Returns records that match a `LIKE` query on the `name` field
  - `custom_field_label_field_type` string: Returns records with the given `field_type`
  - `custom_field_label_custom_field_group` integer: Returns records for the given `custom_field_group_id`

## Response `200`

Successful Response

- CustomFieldLabelList
  - `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` CustomFieldLabelAll[], required: Paginated custom fields
    - `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).
    - `field_type` 'dropdown' | 'multi_select' | 'forecast' | 'text' | 'date' | 'currency' | 'numeric' | 'single_association' | 'multi_association' | 'boolean': Type of custom field
    - `name` string: Name of the custom field
    - `record_type` 'deal' | 'company' | 'person' | 'project': The type of record that association custom fields (`single_association`/`multi_association`) link to. Cannot be changed after the custom field is created.
    - `is_required` boolean, nullable: Whether or not this custom field must be filled in to save it's associated record

## Other responses

- `400`: The request could not be processed as sent (for example a malformed id or an unsupported combination of parameters).
- `403`: The credentials are valid but this user may not perform the action (permissions, a read-only token, or API access switched off).

---

[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)