> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# moco-users
> Moco Users & Reports
**Server path:** `/moco-users` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------- |
| [`moco_users_create_projects_contracts`](#moco_users_create_projects_contracts) | Create project contract |
| [`moco_users_create_session`](#moco_users_create_session) | Create API session |
| [`moco_users_create_tags`](#moco_users_create_tags) | Create tag |
| [`moco_users_create_units`](#moco_users_create_units) | Create unit |
| [`moco_users_create_users`](#moco_users_create_users) | Create user |
| [`moco_users_create_users_employments`](#moco_users_create_users_employments) | Create user employment |
| [`moco_users_delete_employments`](#moco_users_delete_employments) | Delete user employment |
| [`moco_users_delete_projects_contracts`](#moco_users_delete_projects_contracts) | Delete project contract |
| [`moco_users_delete_taggings`](#moco_users_delete_taggings) | Remove taggings from resource |
| [`moco_users_delete_tags`](#moco_users_delete_tags) | Delete tag |
| [`moco_users_delete_units`](#moco_users_delete_units) | Delete unit |
| [`moco_users_delete_users`](#moco_users_delete_users) | Delete user |
| [`moco_users_get_employments`](#moco_users_get_employments) | Get user employment |
| [`moco_users_get_performance_report`](#moco_users_get_performance_report) | Get user performance report |
| [`moco_users_get_projects_contracts`](#moco_users_get_projects_contracts) | Get project contract |
| [`moco_users_get_projects_contracts_1`](#moco_users_get_projects_contracts_1) | List project contracts |
| [`moco_users_get_taggings`](#moco_users_get_taggings) | List taggings for resource |
| [`moco_users_get_tags`](#moco_users_get_tags) | Get tag |
| [`moco_users_get_units`](#moco_users_get_units) | Get unit |
| [`moco_users_get_users`](#moco_users_get_users) | Get user |
| [`moco_users_get_vat_code_purchases`](#moco_users_get_vat_code_purchases) | Get VAT code purchase |
| [`moco_users_get_vat_code_sales`](#moco_users_get_vat_code_sales) | Get VAT code sale |
| [`moco_users_list_letter_papers`](#moco_users_list_letter_papers) | List letter papers |
| [`moco_users_list_profile`](#moco_users_list_profile) | Get current profile |
| [`moco_users_list_report_absences`](#moco_users_list_report_absences) | Get absences report |
| [`moco_users_list_report_cashflow`](#moco_users_list_report_cashflow) | Get cashflow report |
| [`moco_users_list_report_finance`](#moco_users_list_report_finance) | Get finance report |
| [`moco_users_list_report_planned_vs_tracked`](#moco_users_list_report_planned_vs_tracked) | Get planned vs tracked report |
| [`moco_users_list_report_utilization`](#moco_users_list_report_utilization) | Get utilization report |
| [`moco_users_list_session`](#moco_users_list_session) | Verify API key |
| [`moco_users_list_tags`](#moco_users_list_tags) | List tags |
| [`moco_users_list_units`](#moco_users_list_units) | List units |
| [`moco_users_list_users`](#moco_users_list_users) | List users |
| [`moco_users_list_users_employments`](#moco_users_list_users_employments) | List user employments |
| [`moco_users_list_users_roles`](#moco_users_list_users_roles) | List user roles |
| [`moco_users_list_vat_code_purchases`](#moco_users_list_vat_code_purchases) | List VAT code purchases |
| [`moco_users_list_vat_code_sales`](#moco_users_list_vat_code_sales) | List VAT code sales |
| [`moco_users_update_projects_contracts`](#moco_users_update_projects_contracts) | Update project contract |
| [`moco_users_update_projects_contracts_1`](#moco_users_update_projects_contracts_1) | Update project contract |
| [`moco_users_update_taggings`](#moco_users_update_taggings) | Replace taggings for resource |
| [`moco_users_update_taggings_1`](#moco_users_update_taggings_1) | Add taggings to resource |
| [`moco_users_update_tags`](#moco_users_update_tags) | Update tag |
| [`moco_users_update_tags_1`](#moco_users_update_tags_1) | Update tag |
| [`moco_users_update_units`](#moco_users_update_units) | Update unit |
| [`moco_users_update_units_1`](#moco_users_update_units_1) | Update unit |
| [`moco_users_update_users`](#moco_users_update_users) | Update user |
| [`moco_users_update_users_1`](#moco_users_update_users_1) | Update user |
| [`moco_users_update_users_employments`](#moco_users_update_users_employments) | Update user employment |
| [`moco_users_update_users_employments_1`](#moco_users_update_users_employments_1) | Update user employment |
***
## moco\_users\_create\_projects\_contracts
Create project contract
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------ |
| `project_id` | integer | Yes | — | Project Id |
| `active` | boolean | No | — | The active value |
| `billable` | boolean | No | — | The billable value |
| `budget` | number | No | — | The budget value |
| `hourly_rate` | number | No | — | Hourly Rate |
| `user_id` | integer | No | — | User Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "integer",
"description": "Project Id"
},
"active": {
"type": "boolean",
"description": "The active value"
},
"billable": {
"type": "boolean",
"description": "The billable value"
},
"budget": {
"type": "number",
"description": "The budget value"
},
"hourly_rate": {
"type": "number",
"description": "Hourly Rate"
},
"user_id": {
"type": "integer",
"description": "User Id"
}
},
"required": [
"PCID",
"project_id"
]
}
```
***
## moco\_users\_create\_session
Create API session
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------- |
| `email` | string | Yes | — | User email within the account referenced by the subdomain. |
| `password` | string | Yes | — | User password. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email": {
"type": "string",
"description": "User email within the account referenced by the subdomain."
},
"password": {
"type": "string",
"description": "User password."
}
},
"required": [
"PCID",
"email",
"password"
]
}
```
***
## moco\_users\_create\_tags
Create tag
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------- |
| `color` | string | No | — | The color value |
| `context` | string | No | — | `Project` is mapped to internal `Assignment`. |
| `name` | string | No | — | The name value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"color": {
"type": "string",
"description": "The color value"
},
"context": {
"type": "string",
"description": "`Project` is mapped to internal `Assignment`.",
"enum": [
"Company",
"Contact",
"Project",
"Deal",
"Purchase",
"Invoice",
"Offer",
"User"
]
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_create\_units
Create unit
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------ | -------- | ------- | ----------------- |
| `custom_properties` | object | No | — | Custom Properties |
| `name` | string | No | — | The name value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_create\_users
Create user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | --------- | -------- | ------- | -------------------------------------- |
| `active` | boolean | No | — | The active value |
| `avatar` | object | No | — | The avatar value |
| `bday` | string | No | — | The bday value |
| `custom_properties` | object | No | — | Custom Properties |
| `email` | string | No | — | The email value |
| `external` | boolean | No | — | The external value |
| `firstname` | string | No | — | The firstname value |
| `home_address` | string | No | — | Home Address |
| `iban` | string | No | — | The iban value |
| `info` | string | No | — | The info value |
| `language` | string | No | — | The language value |
| `lastname` | string | No | — | Alias for `name`. |
| `mobile_phone` | string | No | — | Mobile Phone |
| `name` | string | No | — | The name value |
| `password` | string | No | — | The password value |
| `role_id` | integer | No | — | Role Id |
| `tags` | string\[] | No | — | The tags value |
| `unit_id` | integer | No | — | Unit Id |
| `welcome_email` | boolean | No | — | Applied on create, defaults to `true`. |
| `work_phone` | string | No | — | Work Phone |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"active": {
"type": "boolean",
"description": "The active value"
},
"avatar": {
"type": "object",
"description": "The avatar value",
"properties": {
"filename": {
"type": "string",
"description": "The filename value"
},
"base64": {
"type": "string",
"description": "The base64 value"
}
}
},
"bday": {
"type": "string",
"description": "The bday value"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"email": {
"type": "string",
"description": "The email value"
},
"external": {
"type": "boolean",
"description": "The external value"
},
"firstname": {
"type": "string",
"description": "The firstname value"
},
"home_address": {
"type": "string",
"description": "Home Address"
},
"iban": {
"type": "string",
"description": "The iban value"
},
"info": {
"type": "string",
"description": "The info value"
},
"language": {
"type": "string",
"description": "The language value",
"enum": [
"de",
"de-AT",
"de-CH",
"en",
"it",
"fr"
]
},
"lastname": {
"type": "string",
"description": "Alias for `name`."
},
"mobile_phone": {
"type": "string",
"description": "Mobile Phone"
},
"name": {
"type": "string",
"description": "The name value"
},
"password": {
"type": "string",
"description": "The password value"
},
"role_id": {
"type": "integer",
"description": "Role Id"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"unit_id": {
"type": "integer",
"description": "Unit Id"
},
"welcome_email": {
"type": "boolean",
"description": "Applied on create, defaults to `true`."
},
"work_phone": {
"type": "string",
"description": "Work Phone"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_create\_users\_employments
Create user employment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ----------------- |
| `from` | string | No | — | The from value |
| `pattern` | object | No | — | The pattern value |
| `to` | string | No | — | The to value |
| `user_id` | integer | No | — | User Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"from": {
"type": "string",
"description": "The from value"
},
"pattern": {
"type": "object",
"description": "The pattern value",
"properties": {
"am": {
"type": "array",
"items": {
"type": "number"
},
"description": "The am value"
},
"pm": {
"type": "array",
"items": {
"type": "number"
},
"description": "The pm value"
}
}
},
"to": {
"type": "string",
"description": "The to value"
},
"user_id": {
"type": "integer",
"description": "User Id"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_delete\_employments
Delete user employment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------ |
| `id` | integer | Yes | — | Resource ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_delete\_projects\_contracts
Delete project contract
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------ |
| `project_id` | integer | Yes | — | Project Id |
| `id` | integer | Yes | — | Resource ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "integer",
"description": "Project Id"
},
"id": {
"type": "integer",
"description": "Resource ID."
}
},
"required": [
"PCID",
"project_id",
"id"
]
}
```
***
## moco\_users\_delete\_taggings
Remove taggings from resource
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | -------------- |
| `taggable_type` | string | Yes | — | Taggable Type |
| `taggable_id` | integer | Yes | — | Taggable Id |
| `tags` | string\[] | No | — | The tags value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taggable_type": {
"type": "string",
"description": "Taggable Type"
},
"taggable_id": {
"type": "integer",
"description": "Taggable Id"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
}
},
"required": [
"PCID",
"taggable_type",
"taggable_id"
]
}
```
***
## moco\_users\_delete\_tags
Delete tag
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `merge_tag_id` | integer | No | — | Optional tag ID to merge existing taggings into. |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"merge_tag_id": {
"type": "integer",
"description": "Optional tag ID to merge existing taggings into."
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_delete\_units
Delete unit
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_delete\_users
Delete user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_get\_employments
Get user employment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------ |
| `id` | integer | Yes | — | Resource ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_get\_performance\_report
Get user performance report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `year` | integer | No | — | Report year. Must be between 2000 and 2100. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"year": {
"type": "integer",
"description": "Report year. Must be between 2000 and 2100."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_get\_projects\_contracts
Get project contract
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------ |
| `project_id` | integer | Yes | — | Project Id |
| `id` | integer | Yes | — | Resource ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "integer",
"description": "Project Id"
},
"id": {
"type": "integer",
"description": "Resource ID."
}
},
"required": [
"PCID",
"project_id",
"id"
]
}
```
***
## moco\_users\_get\_projects\_contracts\_1
List project contracts
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `updated_after` | string | No | — | ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization. |
| `project_id` | integer | Yes | — | Project Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"updated_after": {
"type": "string",
"description": "ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization."
},
"project_id": {
"type": "integer",
"description": "Project Id"
}
},
"required": [
"PCID",
"project_id"
]
}
```
***
## moco\_users\_get\_taggings
List taggings for resource
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ------------- |
| `taggable_type` | string | Yes | — | Taggable Type |
| `taggable_id` | integer | Yes | — | Taggable Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taggable_type": {
"type": "string",
"description": "Taggable Type"
},
"taggable_id": {
"type": "integer",
"description": "Taggable Id"
}
},
"required": [
"PCID",
"taggable_type",
"taggable_id"
]
}
```
***
## moco\_users\_get\_tags
Get tag
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_get\_units
Get unit
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_get\_users
Get user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_get\_vat\_code\_purchases
Get VAT code purchase
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------ |
| `id` | integer | Yes | — | Resource ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_get\_vat\_code\_sales
Get VAT code sale
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------ |
| `id` | integer | Yes | — | Resource ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_list\_letter\_papers
List letter papers
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_profile
Get current profile
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_report\_absences
Get absences report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ---------------- |
| `year` | integer | No | — | The year value |
| `active` | boolean | No | — | The active value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"year": {
"type": "integer",
"description": "The year value"
},
"active": {
"type": "boolean",
"description": "The active value"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_report\_cashflow
Get cashflow report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | --------- | -------- | ------- | ----------------------------------------------------------- |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `from` | string | No | — | Report range start. Format: YYYY-MM-DD (e.g. `2026-01-01`). |
| `to` | string | No | — | Report range end. Format: YYYY-MM-DD (e.g. `2026-01-31`). |
| `term` | string | No | — | The term value |
| `kinds` | string\[] | No | — | The kinds value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"from": {
"type": "string",
"description": "Report range start. Format: YYYY-MM-DD (e.g. `2026-01-01`)."
},
"to": {
"type": "string",
"description": "Report range end. Format: YYYY-MM-DD (e.g. `2026-01-31`)."
},
"term": {
"type": "string",
"description": "The term value"
},
"kinds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The kinds value"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_report\_finance
Get finance report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | --------- | -------- | ------- | ----------------------------------------------------------- |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `from` | string | No | — | Report range start. Format: YYYY-MM-DD (e.g. `2026-01-01`). |
| `to` | string | No | — | Report range end. Format: YYYY-MM-DD (e.g. `2026-01-31`). |
| `term` | string | No | — | The term value |
| `company_id` | integer | No | — | Company Id |
| `kinds` | string\[] | No | — | The kinds value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"from": {
"type": "string",
"description": "Report range start. Format: YYYY-MM-DD (e.g. `2026-01-01`)."
},
"to": {
"type": "string",
"description": "Report range end. Format: YYYY-MM-DD (e.g. `2026-01-31`)."
},
"term": {
"type": "string",
"description": "The term value"
},
"company_id": {
"type": "integer",
"description": "Company Id"
},
"kinds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The kinds value"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_report\_planned\_vs\_tracked
Get planned vs tracked report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ---------- | -------- | ------- | -------------------------------------------------------------- |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `from` | string | No | — | Report range start. Format: YYYY-MM-DD (e.g. `2026-01-01`). |
| `to` | string | No | — | Report range end. Format: YYYY-MM-DD (e.g. `2026-01-31`). |
| `user_ids` | integer\[] | No | — | List of user IDs as repeated params or comma-separated string. |
| `project_id` | integer | No | — | Project Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"from": {
"type": "string",
"description": "Report range start. Format: YYYY-MM-DD (e.g. `2026-01-01`)."
},
"to": {
"type": "string",
"description": "Report range end. Format: YYYY-MM-DD (e.g. `2026-01-31`)."
},
"user_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of user IDs as repeated params or comma-separated string."
},
"project_id": {
"type": "integer",
"description": "Project Id"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_report\_utilization
Get utilization report
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------------------------------- |
| `from` | string | No | — | Report range start. Format: YYYY-MM-DD (e.g. `2026-01-01`). |
| `to` | string | No | — | Report range end. Format: YYYY-MM-DD (e.g. `2026-01-31`). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"from": {
"type": "string",
"description": "Report range start. Format: YYYY-MM-DD (e.g. `2026-01-01`)."
},
"to": {
"type": "string",
"description": "Report range end. Format: YYYY-MM-DD (e.g. `2026-01-31`)."
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_session
Verify API key
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_tags
List tags
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `ids` | string | No | — | Comma-separated IDs. |
| `updated_after` | string | No | — | ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization. |
| `context` | string | No | — | Tag context. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"ids": {
"type": "string",
"description": "Comma-separated IDs."
},
"updated_after": {
"type": "string",
"description": "ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization."
},
"context": {
"type": "string",
"description": "Tag context.",
"enum": [
"Company",
"Contact",
"Project",
"Deal",
"Purchase",
"Invoice",
"Offer",
"User"
]
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_units
List units
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `ids` | string | No | — | Comma-separated IDs. |
| `updated_after` | string | No | — | ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization. |
| `custom_properties` | object | No | — | Filter by custom field values. Unknown custom field names return an empty result set. For MultiSelect fields, pass multiple values using `custom_properties[Field][]=A&custom_properties[Field][]=B`. Boolean fields should be queried with `true` or `false`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"ids": {
"type": "string",
"description": "Comma-separated IDs."
},
"updated_after": {
"type": "string",
"description": "ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization."
},
"custom_properties": {
"type": "object",
"description": "Filter by custom field values. Unknown custom field names return an empty result set. For MultiSelect fields, pass multiple values using `custom_properties[Field][]=A&custom_properties[Field][]=B`. Boolean fields should be queried with `true` or `false`."
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_users
List users
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `sort_by` | string | No | — | Field and optional direction, e.g. `title desc`. |
| `ids` | string | No | — | Comma-separated IDs. |
| `updated_after` | string | No | — | ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization. |
| `custom_properties` | object | No | — | Filter by custom field values. Unknown custom field names return an empty result set. For MultiSelect fields, pass multiple values using `custom_properties[Field][]=A&custom_properties[Field][]=B`. Boolean fields should be queried with `true` or `false`. |
| `include_archived` | boolean | No | — | Include Archived |
| `email` | string | No | — | Filter by exact email address (e.g. `max.muster@example.com`). |
| `tags` | string | No | — | Comma-separated user tag names. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"sort_by": {
"type": "string",
"description": "Field and optional direction, e.g. `title desc`."
},
"ids": {
"type": "string",
"description": "Comma-separated IDs."
},
"updated_after": {
"type": "string",
"description": "ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization."
},
"custom_properties": {
"type": "object",
"description": "Filter by custom field values. Unknown custom field names return an empty result set. For MultiSelect fields, pass multiple values using `custom_properties[Field][]=A&custom_properties[Field][]=B`. Boolean fields should be queried with `true` or `false`."
},
"include_archived": {
"type": "boolean",
"description": "Include Archived"
},
"email": {
"type": "string",
"description": "Filter by exact email address (e.g. `max.muster@example.com`)."
},
"tags": {
"type": "string",
"description": "Comma-separated user tag names."
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_users\_employments
List user employments
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `ids` | string | No | — | Comma-separated IDs. |
| `updated_after` | string | No | — | ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization. |
| `user_id` | integer | No | — | User Id |
| `from` | string | No | — | Employment date range start. Format: YYYY-MM-DD (e.g. `2026-01-01`). |
| `to` | string | No | — | Employment date range end. Format: YYYY-MM-DD (e.g. `2026-01-31`). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"ids": {
"type": "string",
"description": "Comma-separated IDs."
},
"updated_after": {
"type": "string",
"description": "ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization."
},
"user_id": {
"type": "integer",
"description": "User Id"
},
"from": {
"type": "string",
"description": "Employment date range start. Format: YYYY-MM-DD (e.g. `2026-01-01`)."
},
"to": {
"type": "string",
"description": "Employment date range end. Format: YYYY-MM-DD (e.g. `2026-01-31`)."
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_users\_roles
List user roles
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_vat\_code\_purchases
List VAT code purchases
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `ids` | string | No | — | Comma-separated IDs. |
| `updated_after` | string | No | — | ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization. |
| `active` | boolean | No | — | The active value |
| `intra_eu` | boolean | No | — | Intra Eu |
| `reverse_charge` | boolean | No | — | Reverse Charge |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"ids": {
"type": "string",
"description": "Comma-separated IDs."
},
"updated_after": {
"type": "string",
"description": "ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization."
},
"active": {
"type": "boolean",
"description": "The active value"
},
"intra_eu": {
"type": "boolean",
"description": "Intra Eu"
},
"reverse_charge": {
"type": "boolean",
"description": "Reverse Charge"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_list\_vat\_code\_sales
List VAT code sales
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | integer | No | — | Page number, starting at 1. |
| `per_page` | integer | No | — | Page size. |
| `ids` | string | No | — | Comma-separated IDs. |
| `updated_after` | string | No | — | ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization. |
| `active` | boolean | No | — | The active value |
| `intra_eu` | boolean | No | — | Intra Eu |
| `reverse_charge` | boolean | No | — | Reverse Charge |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number, starting at 1."
},
"per_page": {
"type": "integer",
"description": "Page size."
},
"ids": {
"type": "string",
"description": "Comma-separated IDs."
},
"updated_after": {
"type": "string",
"description": "ISO 8601 UTC timestamp (e.g. `2026-01-31T14:30:00Z`). Returns entities created or updated after this timestamp and is intended for incremental synchronization. Combine with delete webhooks for full synchronization."
},
"active": {
"type": "boolean",
"description": "The active value"
},
"intra_eu": {
"type": "boolean",
"description": "Intra Eu"
},
"reverse_charge": {
"type": "boolean",
"description": "Reverse Charge"
}
},
"required": [
"PCID"
]
}
```
***
## moco\_users\_update\_projects\_contracts
Update project contract
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------ |
| `project_id` | integer | Yes | — | Project Id |
| `id` | integer | Yes | — | Resource ID. |
| `active` | boolean | No | — | The active value |
| `billable` | boolean | No | — | The billable value |
| `budget` | number | No | — | The budget value |
| `hourly_rate` | number | No | — | Hourly Rate |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "integer",
"description": "Project Id"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"active": {
"type": "boolean",
"description": "The active value"
},
"billable": {
"type": "boolean",
"description": "The billable value"
},
"budget": {
"type": "number",
"description": "The budget value"
},
"hourly_rate": {
"type": "number",
"description": "Hourly Rate"
}
},
"required": [
"PCID",
"project_id",
"id"
]
}
```
***
## moco\_users\_update\_projects\_contracts\_1
Update project contract
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------ |
| `project_id` | integer | Yes | — | Project Id |
| `id` | integer | Yes | — | Resource ID. |
| `active` | boolean | No | — | The active value |
| `billable` | boolean | No | — | The billable value |
| `budget` | number | No | — | The budget value |
| `hourly_rate` | number | No | — | Hourly Rate |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "integer",
"description": "Project Id"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"active": {
"type": "boolean",
"description": "The active value"
},
"billable": {
"type": "boolean",
"description": "The billable value"
},
"budget": {
"type": "number",
"description": "The budget value"
},
"hourly_rate": {
"type": "number",
"description": "Hourly Rate"
}
},
"required": [
"PCID",
"project_id",
"id"
]
}
```
***
## moco\_users\_update\_taggings
Replace taggings for resource
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | -------------- |
| `taggable_type` | string | Yes | — | Taggable Type |
| `taggable_id` | integer | Yes | — | Taggable Id |
| `tags` | string\[] | No | — | The tags value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taggable_type": {
"type": "string",
"description": "Taggable Type"
},
"taggable_id": {
"type": "integer",
"description": "Taggable Id"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
}
},
"required": [
"PCID",
"taggable_type",
"taggable_id"
]
}
```
***
## moco\_users\_update\_taggings\_1
Add taggings to resource
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | -------------- |
| `taggable_type` | string | Yes | — | Taggable Type |
| `taggable_id` | integer | Yes | — | Taggable Id |
| `tags` | string\[] | No | — | The tags value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taggable_type": {
"type": "string",
"description": "Taggable Type"
},
"taggable_id": {
"type": "integer",
"description": "Taggable Id"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
}
},
"required": [
"PCID",
"taggable_type",
"taggable_id"
]
}
```
***
## moco\_users\_update\_tags
Update tag
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `color` | string | No | — | The color value |
| `name` | string | No | — | The name value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"color": {
"type": "string",
"description": "The color value"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_update\_tags\_1
Update tag
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `color` | string | No | — | The color value |
| `name` | string | No | — | The name value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"color": {
"type": "string",
"description": "The color value"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_update\_units
Update unit
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `custom_properties` | object | No | — | Custom Properties |
| `name` | string | No | — | The name value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_update\_units\_1
Update unit
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `custom_properties` | object | No | — | Custom Properties |
| `name` | string | No | — | The name value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_update\_users
Update user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `active` | boolean | No | — | The active value |
| `avatar` | object | No | — | The avatar value |
| `bday` | string | No | — | The bday value |
| `custom_properties` | object | No | — | Custom Properties |
| `email` | string | No | — | The email value |
| `external` | boolean | No | — | The external value |
| `firstname` | string | No | — | The firstname value |
| `home_address` | string | No | — | Home Address |
| `iban` | string | No | — | The iban value |
| `info` | string | No | — | The info value |
| `language` | string | No | — | The language value |
| `lastname` | string | No | — | Alias for `name`. |
| `mobile_phone` | string | No | — | Mobile Phone |
| `name` | string | No | — | The name value |
| `password` | string | No | — | The password value |
| `role_id` | integer | No | — | Role Id |
| `tags` | string\[] | No | — | The tags value |
| `unit_id` | integer | No | — | Unit Id |
| `welcome_email` | boolean | No | — | Applied on create, defaults to `true`. |
| `work_phone` | string | No | — | Work Phone |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"active": {
"type": "boolean",
"description": "The active value"
},
"avatar": {
"type": "object",
"description": "The avatar value",
"properties": {
"filename": {
"type": "string",
"description": "The filename value"
},
"base64": {
"type": "string",
"description": "The base64 value"
}
}
},
"bday": {
"type": "string",
"description": "The bday value"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"email": {
"type": "string",
"description": "The email value"
},
"external": {
"type": "boolean",
"description": "The external value"
},
"firstname": {
"type": "string",
"description": "The firstname value"
},
"home_address": {
"type": "string",
"description": "Home Address"
},
"iban": {
"type": "string",
"description": "The iban value"
},
"info": {
"type": "string",
"description": "The info value"
},
"language": {
"type": "string",
"description": "The language value",
"enum": [
"de",
"de-AT",
"de-CH",
"en",
"it",
"fr"
]
},
"lastname": {
"type": "string",
"description": "Alias for `name`."
},
"mobile_phone": {
"type": "string",
"description": "Mobile Phone"
},
"name": {
"type": "string",
"description": "The name value"
},
"password": {
"type": "string",
"description": "The password value"
},
"role_id": {
"type": "integer",
"description": "Role Id"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"unit_id": {
"type": "integer",
"description": "Unit Id"
},
"welcome_email": {
"type": "boolean",
"description": "Applied on create, defaults to `true`."
},
"work_phone": {
"type": "string",
"description": "Work Phone"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_update\_users\_1
Update user
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | Resource ID. |
| `X-IMPERSONATE-USER-ID` | integer | No | — | Execute request on behalf of another user if allowed. |
| `active` | boolean | No | — | The active value |
| `avatar` | object | No | — | The avatar value |
| `bday` | string | No | — | The bday value |
| `custom_properties` | object | No | — | Custom Properties |
| `email` | string | No | — | The email value |
| `external` | boolean | No | — | The external value |
| `firstname` | string | No | — | The firstname value |
| `home_address` | string | No | — | Home Address |
| `iban` | string | No | — | The iban value |
| `info` | string | No | — | The info value |
| `language` | string | No | — | The language value |
| `lastname` | string | No | — | Alias for `name`. |
| `mobile_phone` | string | No | — | Mobile Phone |
| `name` | string | No | — | The name value |
| `password` | string | No | — | The password value |
| `role_id` | integer | No | — | Role Id |
| `tags` | string\[] | No | — | The tags value |
| `unit_id` | integer | No | — | Unit Id |
| `welcome_email` | boolean | No | — | Applied on create, defaults to `true`. |
| `work_phone` | string | No | — | Work Phone |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"X-IMPERSONATE-USER-ID": {
"type": "integer",
"description": "Execute request on behalf of another user if allowed."
},
"active": {
"type": "boolean",
"description": "The active value"
},
"avatar": {
"type": "object",
"description": "The avatar value",
"properties": {
"filename": {
"type": "string",
"description": "The filename value"
},
"base64": {
"type": "string",
"description": "The base64 value"
}
}
},
"bday": {
"type": "string",
"description": "The bday value"
},
"custom_properties": {
"type": "object",
"description": "Custom Properties"
},
"email": {
"type": "string",
"description": "The email value"
},
"external": {
"type": "boolean",
"description": "The external value"
},
"firstname": {
"type": "string",
"description": "The firstname value"
},
"home_address": {
"type": "string",
"description": "Home Address"
},
"iban": {
"type": "string",
"description": "The iban value"
},
"info": {
"type": "string",
"description": "The info value"
},
"language": {
"type": "string",
"description": "The language value",
"enum": [
"de",
"de-AT",
"de-CH",
"en",
"it",
"fr"
]
},
"lastname": {
"type": "string",
"description": "Alias for `name`."
},
"mobile_phone": {
"type": "string",
"description": "Mobile Phone"
},
"name": {
"type": "string",
"description": "The name value"
},
"password": {
"type": "string",
"description": "The password value"
},
"role_id": {
"type": "integer",
"description": "Role Id"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"unit_id": {
"type": "integer",
"description": "Unit Id"
},
"welcome_email": {
"type": "boolean",
"description": "Applied on create, defaults to `true`."
},
"work_phone": {
"type": "string",
"description": "Work Phone"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_update\_users\_employments
Update user employment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ----------------- |
| `id` | integer | Yes | — | Resource ID. |
| `from` | string | No | — | The from value |
| `pattern` | object | No | — | The pattern value |
| `to` | string | No | — | The to value |
| `user_id` | integer | No | — | User Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"from": {
"type": "string",
"description": "The from value"
},
"pattern": {
"type": "object",
"description": "The pattern value",
"properties": {
"am": {
"type": "array",
"items": {
"type": "number"
},
"description": "The am value"
},
"pm": {
"type": "array",
"items": {
"type": "number"
},
"description": "The pm value"
}
}
},
"to": {
"type": "string",
"description": "The to value"
},
"user_id": {
"type": "integer",
"description": "User Id"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## moco\_users\_update\_users\_employments\_1
Update user employment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ----------------- |
| `id` | integer | Yes | — | Resource ID. |
| `from` | string | No | — | The from value |
| `pattern` | object | No | — | The pattern value |
| `to` | string | No | — | The to value |
| `user_id` | integer | No | — | User Id |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Resource ID."
},
"from": {
"type": "string",
"description": "The from value"
},
"pattern": {
"type": "object",
"description": "The pattern value",
"properties": {
"am": {
"type": "array",
"items": {
"type": "number"
},
"description": "The am value"
},
"pm": {
"type": "array",
"items": {
"type": "number"
},
"description": "The pm value"
}
}
},
"to": {
"type": "string",
"description": "The to value"
},
"user_id": {
"type": "integer",
"description": "User Id"
}
},
"required": [
"PCID",
"id"
]
}
```