---
updatedAt: 2025-12-16T09:38:48.000Z
---
Fetch the complete documentation index at: https://apidocs.hibob.com/llms.txt. Use this file to discover all available pages before exploring further.
# Get Project Client 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 project client search endpoint.
# OpenAPI definition
```json
{
"openapi": "3.1.1",
"info": {
"title": "Attendance API",
"contact": {
"name": "Hi Bob, Inc."
},
"description": "Public API for importing attendance entries and managing attendance projects, tasks, and clients. Supports detailed field metadata and flexible filtering.",
"license": {
"name": "Proprietary",
"url": "https://apidocs.hibob.com/docs/api-terms-of-use"
},
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.hibob.com/v1",
"description": "Production"
},
{
"url": "https://api.sandbox.hibob.com/v1",
"description": "Sandbox"
}
],
"x-readme": {
"metrics-enabled": false
},
"tags": [
{
"name": "Projects",
"description": "Operations for managing attendance projects, tasks and clients"
}
],
"paths": {
"/attendance/project-clients/metadata": {
"get": {
"operationId": "get_attendance-project-clients-metadata",
"tags": [
"Projects"
],
"summary": "Get Project Client Metadata",
"description": "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 project client search endpoint.\n",
"responses": {
"200": {
"description": "Project client fields metadata",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetadataResponse"
},
"example": {
"items": [
{
"id": "projectClient",
"displayName": "The Project Client Object",
"fields": [
{
"id": "/projectClient/id",
"type": {
"dataType": "entity_id"
},
"propertiesValues": {
"displayName": {
"value": "ID"
},
"description": {
"value": ""
},
"isRequired": {
"value": false
}
}
},
{
"id": "/projectClient/name",
"type": {
"dataType": "text"
},
"propertiesValues": {
"displayName": {
"value": "Name"
},
"description": {
"value": "The name of the client"
},
"isRequired": {
"value": true
}
}
}
]
}
]
}
}
}
},
"400": {
"description": "The request is malformed or includes invalid parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Authentication failed. Check your service user credentials",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "The service user or token is missing the required permissions to access the requested data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"429": {
"description": "Rate limit exceeded - see Rate limits",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"500": {
"description": "An unexpected error occurred. Try again or contact support if the issue persists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"security": [
{
"basic": []
},
{
"Bearer": []
}
]
}
}
},
"components": {
"securitySchemes": {
"basic": {
"type": "http",
"scheme": "basic",
"description": "Basic HTTP authentication using service user credentials"
},
"Bearer": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "OAuth 2.0",
"description": "OAuth 2.0 authentication using an Access Token is available for registered partners only. Try It! does not support the full HiBob OAuth flow. You can follow these steps to complete the OAuth 2.0 flow in Postman and then paste the token here."
}
},
"schemas": {
"ApiErrorResponse": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Error key identifier"
},
"error": {
"type": "string",
"description": "Human-readable error message"
},
"args": {
"type": "array",
"description": "Optional error arguments providing additional context",
"items": {
"type": "string"
}
}
}
},
"FieldMetadata": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Field identifier path"
},
"type": {
"type": "object",
"properties": {
"dataType": {
"type": "string",
"enum": [
"text",
"long_text",
"number",
"boolean",
"date",
"entity_id",
"currency_value",
"json",
"objectReference"
],
"description": "The data type of a field"
},
"typeData": {
"type": "object",
"description": "Additional type-specific data (e.g., reference information for objectReference types)",
"properties": {
"referenceId": {
"type": "string",
"description": "The referenced object type ID (used with objectReference dataType)",
"example": "projectClient"
}
}
}
}
},
"propertiesValues": {
"type": "object",
"description": "Field display properties and constraints",
"properties": {
"displayName": {
"description": "Human-readable label for the field",
"type": "object",
"properties": {
"value": {
"type": "string"
}
}
},
"description": {
"type": "object",
"description": "Description of how the field is used and other notes",
"properties": {
"value": {
"type": "string"
}
}
},
"isRequired": {
"type": "object",
"description": "Whether the field is required when creating records",
"properties": {
"value": {
"type": "boolean"
}
}
}
}
}
}
},
"MetadataObject": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Object type identifier"
},
"displayName": {
"type": "string",
"description": "Human-readable name"
},
"fields": {
"type": "array",
"description": "List of fields available on this object type",
"items": {
"$ref": "#/components/schemas/FieldMetadata"
}
}
}
},
"MetadataResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataObject"
}
}
}
}
}
}
}
```