---
title: "Get Project Client Metadata"
method: GET
path: "/attendance/project-clients/metadata"
tags: ["Projects"]
---

# Get Project Client Metadata

`GET /attendance/project-clients/metadata`

Returns the project client fields (out-of-the-box only) fields and custom fields. Use the field ID in fields and filters when calling the <a href="/reference/post_attendance-project-clients-search" target="_blank">project client search endpoint</a>.

## Response `200`

Project client fields metadata

- MetadataResponse
  - `items` MetadataObject[]
    - `id` 'goal' | 'goalType' | 'goalCycle' | 'keyResult' — The object identifier
    - `displayName` 'The Goal Object' | 'The Goal Type Object' | 'The Goal Cycle Object' | 'The Key Result Object' — Human-readable object name
    - `fields` FieldMetadata[] — Array of field metadata for this object type
      - `id` string, required — Path-style field ID (for example `/employer/legalName`). Use this value in the `fields` and `filters` of the matching search endpoint.
      - `type` FieldDataType, required — Data-type wrapper for a field, per the metadata guideline.
        - `dataType` string, required — Field data type. One of the basic types `text`, `date`, `short-date`, `boolean`, `number`, `time`, `currency`, or the reference types `objectReference`, `employee-reference`, `document`, `list`, `multi-list`, `hierarchy-list`.
        - `referenceId` string, nullable — Reference target. Present only when `dataType` is `objectReference` (the referenced object type) or `list` / `multi-list` / `hierarchy-list` (the referenced list ID, for example `countries`).
      - `displayName` string, nullable — Human-readable display name of the field.
      - `description` string, nullable — Field description / help text.
      - `isRequired` boolean, nullable — Whether the field must be supplied when creating the object. Reads in this API are read-only regardless of this flag.
      - `status` string, nullable — Field status — `active` or `archived`.
      - `validations` Validation[], nullable — Validation rules that apply to the field.
        - `type` string, nullable — Validation type (for example `regex`).
        - `value` string, nullable — Validation value (for example a regular-expression pattern).

## Other responses

- `400` — The request is malformed or includes invalid parameters
- `401` — Authentication failed. Check your service user credentials
- `403` — The service user or token is missing the required permissions to access the requested data
- `429` — Rate limit exceeded - see <a href="https://apidocs.hibob.com/reference/project-clients#rate-limiting">Rate limits</a>
- `500` — An unexpected error occurred. Try again or contact support if the issue persists.

---

[API](https://skmtc.net/hibob/apis/employee-data-api.md) · [All operations](https://skmtc.net/hibob/apis/employee-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hibob/employee-data-api/versions/0781ebbdda91/schema)