List Field Layout by Entity Type¶
GET https://api.copper.com/developer_api/v1/field_layouts/by_entity/:entity_type?pipeline_id=X
Field Layouts¶
A field layout is an array of field objects. It defines which fields are applicable to a given entity type, as well as the order in which they are displayed. Field layouts are configured in app.copper.com under Settings > Manage Fields On Records.
When requesting a field layout for the "opportunities" entity_type, you MUST specify a pipeline_id as well.
Field Attributes¶
Each field in a field layout has the following attributes
| Field | Type | Details |
|---|---|---|
| field_id | identifier | The id of the field. Default fields are just sequential integers, custom-fields and embedded-app_fields are the ids of those entities. |
| field_label | string | The user-friendly label of the field. |
| field_key | string | An internal identifying name of the field. Custom fields follow the format cf_ |
| field_type | string | The field type, either 'static_field', 'custom_field' or 'embedded_app_field' |
| enabled | boolean | If the field is enabled for the current entity_type in the webapp. |
| required | boolean | If the field is required to be set on create. |
| required_editable | boolean | If the field is required to be set on edit. |
Example Requests¶
People Field Layout¶
curl --location --request GET "https://api.copper.com/developer_api/v1/field_layouts/by_entity/people" \
--header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
--header "X-PW-Application: developer_api" \
--header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
--header "Content-Type: application/json"
[
{
"field_id": 0,
"field_label": "Name",
"field_key": "full_name",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 2,
"field_label": "Company",
"field_key": "primary_organization",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 1,
"field_label": "Title",
"field_key": "title",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 3,
"field_label": "Contact Type",
"field_key": "contact_group_id",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 4,
"field_label": "Owner",
"field_key": "assignee",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 5,
"field_label": "Emails",
"field_key": "emails",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 6,
"field_label": "Phones",
"field_key": "phones",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 7,
"field_label": "Websites",
"field_key": "websites",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 8,
"field_label": "Social Media Accounts",
"field_key": "socials",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 9,
"field_label": "Address",
"field_key": "address",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 10,
"field_label": "Visibility",
"field_key": "visibility",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 11,
"field_label": "Description",
"field_key": "details",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 12,
"field_label": "Tags",
"field_key": "tags",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 23,
"field_label": "My Custom Field",
"field_key": "cf_23",
"field_type": "custom_field",
"enabled": false,
"required": true,
"required_editable": true
}
]
Opportunities Field Layout¶
curl --location --request GET "https://api.copper.com/developer_api/v1/field_layouts/by_entity/opportunities?pipeline_id=123" \
--header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
--header "X-PW-Application: developer_api" \
--header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
--header "Content-Type: application/json"
[
{
"field_id": 0,
"field_label": "Name",
"field_key": "name",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": false
},
{
"field_id": 5,
"field_label": "Pipeline",
"field_key": "pipeline_id",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": false
},
{
"field_id": 1,
"field_label": "Primary Contact",
"field_key": "related_contact",
"field_type": "static_field",
"enabled": true,
"required": true,
"required_editable": true
},
{
"field_id": 2,
"field_label": "Close Date",
"field_key": "deal_date",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 3,
"field_label": "Company",
"field_key": "related_organization",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 4,
"field_label": "Status",
"field_key": "status",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": false
},
{
"field_id": 6,
"field_label": "Owner",
"field_key": "assignee",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 7,
"field_label": "Stage",
"field_key": "stage_id",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": false
},
{
"field_id": 8,
"field_label": "Source",
"field_key": "customer_source_id",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 9,
"field_label": "Created",
"field_key": "created_date",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": false
},
{
"field_id": 10,
"field_label": "Value",
"field_key": "monetary_value",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 11,
"field_label": "Priority",
"field_key": "priority",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 12,
"field_label": "Win Percentage",
"field_key": "win_probability",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 13,
"field_label": "Loss Reason",
"field_key": "loss_reason_id",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 14,
"field_label": "Visibility",
"field_key": "visibility",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": false
},
{
"field_id": 15,
"field_label": "Description",
"field_key": "details",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 16,
"field_label": "Tags",
"field_key": "tags",
"field_type": "static_field",
"enabled": true,
"required": false,
"required_editable": true
},
{
"field_id": 24,
"field_label": "DealCF1",
"field_key": "cf_24",
"field_type": "custom_field",
"enabled": true,
"required": false,
"required_editable": true
}
]