> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Peerdom

> Peerdom helps organizations map roles, people, groups, projects, goals, pages, and cards through a collaborative organizational platform.

![Peerdom logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/peerdom.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=fb53556b9ab6c83dd1abc1e23d7f34ec)

* **Category:** project management
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 19
* **Triggers:** 0
* **Slug:** `PEERDOM`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Custom Field Definition
>
> **Slug:** `PEERDOM_CREATE_CUSTOM_FIELD_DEFINITION`
>
> Create one custom-field definition that controls a named field's owner, type, multiplicity, order, and visibility.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Definition name and API key used when writing custom-field values.
>
> **order** `integer` *required*
>
> Display order among custom fields.
>
> **entity** `string ("node" | "peer" | "project" | "goal")` *required*
>
> Entity type that owns this field.
>
> **public** `boolean` *required*
>
> Whether the field is publicly visible in Peerdom public data.
>
> **node\_type** `string ("circle" | "role" | "generic")` *required*
>
> Applicable node subtype; use generic for peer fields.
>
> **field\_type** `string ("text" | "textarea" | "email" | "link" | "date" | "relation" | "image" | "list")` *required*
>
> Value type enforced by Peerdom.
>
> **multi\_entry** `boolean` *required*
>
> Whether entities may store multiple values for this field.
>
> **translation** `object`
>
> Optional display labels keyed by Peerdom's supported language codes.
>
> **relation\_scope** `string ("group" | "page" | "peer" | "role")`
>
> Allowed target type. Required when field\_type is relation; omit for all other field types.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Group
>
> **Slug:** `PEERDOM_CREATE_GROUP`
>
> Create a group from an existing parent-group anchor on a map. Set external to true to detach the new group as a top-level external group.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the new group.
>
> **color** `string`
>
> Optional display color. Use a palette hex value returned by GET\_ORGANIZATION\_CONTEXT; arbitrary hex colors are rejected. Omit this field to let Peerdom choose its default color.
>
> **shape** `string ("circle")`
>
> Node shape. Only circle is exposed because it is the live-verified safe value.
>
> **map\_id** `string` *required*
>
> Map that will contain the group; resolve it with GET\_ORGANIZATION\_CONTEXT.
>
> **external** `boolean`
>
> Create an external top-level group. parent\_group\_id is still required as Peerdom's creation anchor.
>
> **custom\_fields** `object`
>
> Values keyed by existing node custom-field definition name.
>
> **parent\_group\_id** `string` *required*
>
> Existing parent group used as the creation anchor. Required even when external is true; external=true detaches the created group afterward.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Peer
>
> **Slug:** `PEERDOM_CREATE_PEER`
>
> Create an email-free person record in the organization; this tool deliberately cannot provision a Peerdom login account.
>
> #### Input Parameters
>
> **nickname** `string` *required*
>
> Peer's display nickname; part of the verified minimum create shape.
>
> **birthdate** `string`
>
> Birth date in YYYY-MM-DD form.
>
> **last\_name** `string` *required*
>
> Peer's last name; part of the verified minimum create shape.
>
> **first\_name** `string` *required*
>
> Peer's first name; part of the verified minimum create shape.
>
> **custom\_fields** `object`
>
> Values keyed by existing custom-field definition name; list definitions before using this field.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Role
>
> **Slug:** `PEERDOM_CREATE_ROLE`
>
> Create a role on a map using core role fields that do not require Peerdom's Contribution or Goals apps. The supplied parent group anchors creation; an external role is detached as a top-level node.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the new role.
>
> **color** `string`
>
> Optional display color. Use a palette hex value returned by GET\_ORGANIZATION\_CONTEXT; arbitrary hex colors may be rejected. Omit this field to let Peerdom choose its default color.
>
> **map\_id** `string` *required*
>
> ID of the map that will contain the role.
>
> **external** `boolean`
>
> Whether the role is external to the organization.
>
> **custom\_fields** `object`
>
> Values keyed by existing role custom-field definition name; list definitions before using this field.
>
> **parent\_group\_id** `string` *required*
>
> ID of the group under which to create the role.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Deactivate Peer
>
> **Slug:** `PEERDOM_DEACTIVATE_PEER`
>
> Mark a peer as former. This is a soft delete: the peer is removed from normal active-peer reads but remains available when former peers are included.
>
> #### Input Parameters
>
> **peer\_id** `string` *required*
>
> ID of the peer to mark as former.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Custom Field Definition
>
> **Slug:** `PEERDOM_DELETE_CUSTOM_FIELD_DEFINITION`
>
> Permanently delete a custom-field definition. WARNING: Peerdom cascade-deletes every value stored against the definition; this cannot be undone and requires explicit confirmation.
>
> #### Input Parameters
>
> **definition\_id** `string` *required*
>
> ID of the custom-field definition to permanently delete. Every value stored against this definition will also be deleted.
>
> **confirm\_cascade\_delete** `boolean ("true")` *required*
>
> Must be true to confirm permanent deletion of the definition and all values stored against it. This confirmation is validated locally and is not sent to Peerdom.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Group
>
> **Slug:** `PEERDOM_DELETE_GROUP`
>
> Permanently delete one group after reading it to block accidental root-group deletion. Root deletion requires separate explicit authorization.
>
> #### Input Parameters
>
> **group\_id** `string` *required*
>
> ID of the group to delete; do not pass a map's root group unless removal is intended.
>
> **confirm\_delete** `boolean ("true")` *required*
>
> Must be true to confirm permanent deletion of this group.
>
> **allow\_root\_group\_delete** `boolean ("true")`
>
> Set true only to explicitly allow deleting a map root group. Root deletion can remove a large organizational subtree. External top-level groups are not map roots and do not need it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Role
>
> **Slug:** `PEERDOM_DELETE_ROLE`
>
> Delete one role by ID and return the deleted role for confirmation.
>
> #### Input Parameters
>
> **role\_id** `string` *required*
>
> ID of the role to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Field Definitions
>
> **Slug:** `PEERDOM_GET_CUSTOM_FIELD_DEFINITIONS`
>
> List custom-field definitions or return one definition by ID so agents can use the organization's real field names and value types.
>
> #### Input Parameters
>
> **entity** `string ("node" | "peer" | "project" | "goal")`
>
> Only list definitions owned by this entity type; ignored for exact lookup.
>
> **definition\_id** `string`
>
> Definition ID to retrieve. Omit to list definitions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Groups
>
> **Slug:** `PEERDOM_GET_GROUPS`
>
> List organization groups or return one group by ID, with optional map and peer filters and optional custom-field-value expansion.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum groups in this page (1-100); used only when listing.
>
> **map\_id** `string`
>
> Only list groups on this map; omit for the live map.
>
> **peer\_id** `string`
>
> Only list groups associated with this peer.
>
> **group\_id** `string`
>
> Group ID to retrieve. Omit to list groups.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by an earlier list call.
>
> **include\_custom\_fields** `boolean`
>
> Include custom-field values on returned groups.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Organization Context
>
> **Slug:** `PEERDOM_GET_ORGANIZATION_CONTEXT`
>
> Return the connected Peerdom organization and its maps, including the live map ID and tenant palette needed to create groups and roles.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Peers
>
> **Slug:** `PEERDOM_GET_PEERS`
>
> List peers with optional former-peer and custom-field inclusion, or return one peer by ID with optional roles and custom fields.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum peers in this page (1-100); used only when listing.
>
> **include** `array`
>
> Related data to include. roles applies only when peer\_id is supplied; customfields works for list and detail.
>
> **peer\_id** `string`
>
> Peer ID to retrieve. Omit to list peers.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by an earlier list call.
>
> **include\_former** `boolean`
>
> Include former peers; required to retrieve a peer after deactivation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Roles
>
> **Slug:** `PEERDOM_GET_ROLES`
>
> List roles or return one role by ID, with optional peer, group, and map filters plus holder, group, representing-node, and custom-field expansions.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum roles in this page (1-100); used only when listing.
>
> **map\_id** `string`
>
> Only list roles on this map; omit for the live map.
>
> **include** `array`
>
> Related role data to include: holders, customfields, groups, or representing. Multiple values may be supplied.
>
> **peer\_id** `string`
>
> Only list roles held by this peer; takes precedence over group\_id.
>
> **role\_id** `string`
>
> Role ID to retrieve. Omit to list roles.
>
> **group\_id** `string`
>
> Only list roles in this group; ignored when peer\_id is supplied.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by an earlier list call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unassign Role Holder
>
> **Slug:** `PEERDOM_UNASSIGN_ROLE_HOLDER`
>
> Remove one peer's assignment from one role without deleting either the peer or the role.
>
> #### Input Parameters
>
> **peer\_id** `string` *required*
>
> Peer whose role assignment to remove.
>
> **role\_id** `string` *required*
>
> Role from which to remove the peer.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Field Definition
>
> **Slug:** `PEERDOM_UPDATE_CUSTOM_FIELD_DEFINITION`
>
> Rename a custom-field definition and its custom-field API key, or update its labels, display order, or public visibility without changing its value type or owner.
>
> #### Input Parameters
>
> **name** `string`
>
> New definition name; this also changes the API key used to write custom-field values.
>
> **order** `integer`
>
> New display order.
>
> **public** `boolean`
>
> New public visibility state.
>
> **translation** `object`
>
> Replacement display labels keyed by supported language code.
>
> **definition\_id** `string` *required*
>
> ID of the custom-field definition to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Group
>
> **Slug:** `PEERDOM_UPDATE_GROUP`
>
> Update selected group properties such as name, parent, external state, color, shape, or custom fields. Changing external state can also change the parent link.
>
> #### Input Parameters
>
> **name** `string`
>
> New group name; omit to preserve it.
>
> **color** `string`
>
> New display color. Use a palette hex value returned by GET\_ORGANIZATION\_CONTEXT; arbitrary hex colors may be rejected. Omit to preserve the current color.
>
> **shape** `string ("circle")`
>
> New node shape. Only circle is exposed because it is the live-verified safe value; omit to preserve the current shape.
>
> **external** `boolean`
>
> Whether the group is external; omit to preserve it.
>
> **group\_id** `string` *required*
>
> ID of the group to update.
>
> **custom\_fields** `object`
>
> Named custom-field values to update.
>
> **parent\_group\_id** `string`
>
> New parent group ID; omit to preserve it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Peer
>
> **Slug:** `PEERDOM_UPDATE_PEER`
>
> Update selected profile fields on an existing peer; omitted fields remain unchanged despite the provider using PUT.
>
> #### Input Parameters
>
> **peer\_id** `string` *required*
>
> ID of the peer to update.
>
> **nickname** `string`
>
> New display nickname; omit to preserve it.
>
> **last\_name** `string`
>
> New last name; omit to preserve it.
>
> **first\_name** `string`
>
> New first name; omit to preserve it.
>
> **custom\_fields** `object`
>
> Replacement values for named custom fields included in this update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Role
>
> **Slug:** `PEERDOM_UPDATE_ROLE`
>
> Update selected core role properties without changing Contribution- or Goals-specific settings.
>
> #### Input Parameters
>
> **name** `string`
>
> New role name; omit to preserve it.
>
> **color** `string`
>
> New display color. Use a palette hex value returned by GET\_ORGANIZATION\_CONTEXT; arbitrary hex colors may be rejected. Omit to preserve the current color.
>
> **role\_id** `string` *required*
>
> ID of the role to update.
>
> **external** `boolean`
>
> Whether the role is external; omit to preserve it.
>
> **custom\_fields** `object`
>
> Named custom-field values to update.
>
> **parent\_group\_id** `string`
>
> New parent group ID; omit to preserve it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign Or Update Role Holder
>
> **Slug:** `PEERDOM_UPSERT_ROLE_HOLDER`
>
> Ensure a peer holds a role, creating the assignment when absent or updating its percentage, focus, and elected-until date when present.
>
> #### Input Parameters
>
> **focus** `string`
>
> Optional focus or responsibility note for the assignment.
>
> **peer\_id** `string` *required*
>
> Peer who should hold the role.
>
> **role\_id** `string` *required*
>
> Role to assign.
>
> **percentage** `number`
>
> Allocation percentage for this role; omit when no change is needed.
>
> **elected\_until** `string`
>
> Optional election end date in YYYY-MM-DD form.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
