Project Custom Metadata API

The Project Custom Fields API lets you define structured metadata tailored to your workflows. Create fields once, and they appear everywhere within your project's scope.

Base URL

https://{domain}.egnyte.com/pubapi/v1/properties/project-tag/custom-fields

Authentication

All requests require an OAuth 2.0 Bearer token in the Authorization header:

Authorization: Bearer {access_token}

See Authentication for details on obtaining a token.

Key Capabilities

• Define custom metadata fields with multiple data types: string, integer, decimal, date, enum (dropdown with single select), multi_value_enum (dropdown with multi select), labels.
• Manage lifecycle via create, update, and delete operations.

Prerequisites

• Active Egnyte account with the Projects feature enabled.
• Customized project metadata must be enabled for your domain.
• API access token with the required scopes.

Common HTTP Headers

Endpoints Summary

List All Custom Field Definitions

Fetch all project custom field definitions for the domain.

Request

GET /pubapi/v1/properties/project-tag/custom-fields

Example Request

curl -i -X GET "https://{domain}.egnyte.com/pubapi/v1/properties/project-tag/custom-fields" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

200 OK

Returns a keys object — a dictionary of custom field definitions keyed by field name.

Example Response

{
  "keys": {
    "budget_code": {
      "name": "budget_code",
      "displayName": "Budget Code",
      "type": "string",
      "helpText": "Enter the project budget code",
      "priority": 100,
      "createdAt": "2026-03-10T10:30:00Z",
      "updatedAt": "2026-03-10T10:30:00Z"
    },
    "project_category": {
      "name": "project_category",
      "displayName": "Project Category",
      "type": "enum",
      "data": ["Infrastructure", "Development", "Research", "Operations"],
      "helpText": "Select the project category",
      "priority": 150,
      "createdAt": "2026-03-10T10:35:00Z",
      "updatedAt": "2026-03-10T10:35:00Z"
    },
    "project_tags": {
      "name": "project_tags",
      "displayName": "Project Tags",
      "type": "labels",
      "data": ["high-priority", "customer-facing", "internal"],
      "helpText": "Add relevant tags for this project",
      "priority": 200,
      "createdAt": "2026-03-10T10:40:00Z",
      "updatedAt": "2026-03-10T11:20:00Z"
    },
    "start_date": {
      "name": "start_date",
      "displayName": "Start Date",
      "type": "date",
      "helpText": "Project start date",
      "priority": 300,
      "timezoneIndependent": true,
      "createdAt": "2026-03-10T10:45:00Z",
      "updatedAt": "2026-03-10T10:45:00Z"
    }
  }
}

HTTP Status Codes

Create a Custom Field Definition

Create a new project custom field definition.

Request

POST /pubapi/v1/properties/project-tag/custom-fields

Request Body

Validation Rules

1. Dropdown with Single Select & Dropdown with Multi Select: Provide a non-empty data array.
2. Labels: Provide a non-empty data array — optional but recommended.
3. Primitive types: Do not include data for string, integer, decimal, date.
4. Reserved field: project_status is a reserved field. New custom status values can be added to it, but its displayName, helpText, priority, and default status cannot be modified.
5. Name generation: Derived from displayName — lowercase, spaces become hyphens. Must be unique per domain.
6. Duplicate names: Auto-resolved with numeric suffixes (e.g., field-1, field-2).
7. Max limit: Respect the domain's maximum custom fields limit.

Example Request — Create a Labels Field

curl -i -X POST "https://{domain}.egnyte.com/pubapi/v1/properties/project-tag/custom-fields" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -d '{
  "displayName": "Project Tags",
  "type": "labels",
  "data": [
    "infrastructure",
    "customer-facing",
    "internal"
  ],
  "helpText": "Add relevant tags (you can add custom values)",
  "priority": 200
}'

Example Request — Create a Multi-Select Dropdown

curl -i -X POST "https://{domain}.egnyte.com/pubapi/v1/properties/project-tag/custom-fields" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -d '{
  "displayName": "Project Tags",
  "type": "multi_value_enum",
  "data": [
    "infrastructure",
    "customer-facing",
    "internal"
  ],
  "helpText": "Add relevant tags (you can add custom values)",
  "priority": 200
}'

Response

HTTP Status Codes

Update a Custom Field Definition

Update an existing custom field definition.

Request

PATCH /pubapi/v1/properties/project-tag/custom-fields/{field_name}

Path Parameters

Request Body

All fields are optional.

Example Request

curl -i -X PATCH "https://{domain}.egnyte.com/pubapi/v1/properties/project-tag/custom-fields/{field_name}" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -d '{
  "displayName": "Project Tags (Updated)",
  "data": [
    "architecture"
  ],
  "helpText": "Updated help text for project tags",
  "priority": 150
}'

Response

HTTP Status Codes

Delete Custom Field Definition Data

Remove specific data values from an enum, labels, or multi_value_enum field, and remove their usage from all existing projects.

Request

PATCH /pubapi/v1/properties/project-tag/custom-fields/{field_name}/data

Path Parameters

Request Body

A JSON array of string values to delete:

[
  "infrastructure",
  "customer-facing",
  "internal"
]

Example Request

curl -i -X PATCH "https://{domain}.egnyte.com/pubapi/v1/properties/project-tag/custom-fields/{field_name}/data" \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -d '[
  "infrastructure",
  "customer-facing",
  "internal"
]'

Response

HTTP Status Codes

Delete a Custom Field Definition

Delete a custom field definition and remove all its values from all existing projects.

Request

DELETE /pubapi/v1/properties/project-tag/custom-fields/{field_name}

Path Parameters

Example Request

curl -i -X DELETE "https://{domain}.egnyte.com/pubapi/v1/properties/project-tag/custom-fields/{field_name}" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

HTTP Status Codes

Timezone-Independent Date Fields

date-type custom fields support a timezoneIndependent flag.

Default: New date fields created via the Public API default to timezoneIndependent: false (timezone-dependent). To opt in to timezone-independent behavior, explicitly set timezoneIndependent: true.

Irreversible: Once a field is set to timezoneIndependent: true, it cannot be changed back to false.

Data Types

Supported field types for custom field definitions:

Error Codes

Errors follow a standard response format:

{
  "errorMessage": "Human-readable error description",
  "errorCode": "MACHINE_READABLE_CODE"
}

Related Resources

• Authentication — How to obtain and refresh OAuth tokens
• Metadata API — Manage custom metadata on files and folders
• Project Folder API — Manage project folders and metadata