Skip to main content
Peerdom logo
  • Category: project management
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 19
  • Triggers: 0
  • Slug: PEERDOM
  • Version: 20261101_00

Tools

Slug: PEERDOM_CREATE_CUSTOM_FIELD_DEFINITIONCreate one custom-field definition that controls a named field’s owner, type, multiplicity, order, and visibility.

Input Parameters

string
required
Definition name and API key used when writing custom-field values.
integer
required
Display order among custom fields.
string ("node" | "peer" | "project" | "goal")
required
Entity type that owns this field.
boolean
required
Whether the field is publicly visible in Peerdom public data.
string ("circle" | "role" | "generic")
required
Applicable node subtype; use generic for peer fields.
string ("text" | "textarea" | "email" | "link" | "date" | "relation" | "image" | "list")
required
Value type enforced by Peerdom.
boolean
required
Whether entities may store multiple values for this field.
object
Optional display labels keyed by Peerdom’s supported language codes.
string ("group" | "page" | "peer" | "role")
Allowed target type. Required when field_type is relation; omit for all other field types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_CREATE_GROUPCreate 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

string
required
Name of the new group.
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.
string ("circle")
Node shape. Only circle is exposed because it is the live-verified safe value.
string
required
Map that will contain the group; resolve it with GET_ORGANIZATION_CONTEXT.
boolean
Create an external top-level group. parent_group_id is still required as Peerdom’s creation anchor.
object
Values keyed by existing node custom-field definition name.
string
required
Existing parent group used as the creation anchor. Required even when external is true; external=true detaches the created group afterward.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_CREATE_PEERCreate an email-free person record in the organization; this tool deliberately cannot provision a Peerdom login account.

Input Parameters

string
required
Peer’s display nickname; part of the verified minimum create shape.
string
Birth date in YYYY-MM-DD form.
string
required
Peer’s last name; part of the verified minimum create shape.
string
required
Peer’s first name; part of the verified minimum create shape.
object
Values keyed by existing custom-field definition name; list definitions before using this field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_CREATE_ROLECreate 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

string
required
Name of the new role.
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.
string
required
ID of the map that will contain the role.
boolean
Whether the role is external to the organization.
object
Values keyed by existing role custom-field definition name; list definitions before using this field.
string
required
ID of the group under which to create the role.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_DEACTIVATE_PEERMark 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

string
required
ID of the peer to mark as former.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_DELETE_CUSTOM_FIELD_DEFINITIONPermanently 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

string
required
ID of the custom-field definition to permanently delete. Every value stored against this definition will also be deleted.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_DELETE_GROUPPermanently delete one group after reading it to block accidental root-group deletion. Root deletion requires separate explicit authorization.

Input Parameters

string
required
ID of the group to delete; do not pass a map’s root group unless removal is intended.
boolean ("true")
required
Must be true to confirm permanent deletion of this group.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_DELETE_ROLEDelete one role by ID and return the deleted role for confirmation.

Input Parameters

string
required
ID of the role to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_GET_CUSTOM_FIELD_DEFINITIONSList custom-field definitions or return one definition by ID so agents can use the organization’s real field names and value types.

Input Parameters

string ("node" | "peer" | "project" | "goal")
Only list definitions owned by this entity type; ignored for exact lookup.
string
Definition ID to retrieve. Omit to list definitions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_GET_GROUPSList organization groups or return one group by ID, with optional map and peer filters and optional custom-field-value expansion.

Input Parameters

integer
Maximum groups in this page (1-100); used only when listing.
string
Only list groups on this map; omit for the live map.
string
Only list groups associated with this peer.
string
Group ID to retrieve. Omit to list groups.
string
Opaque continuation cursor returned by an earlier list call.
boolean
Include custom-field values on returned groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_GET_ORGANIZATION_CONTEXTReturn the connected Peerdom organization and its maps, including the live map ID and tenant palette needed to create groups and roles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_GET_PEERSList peers with optional former-peer and custom-field inclusion, or return one peer by ID with optional roles and custom fields.

Input Parameters

integer
Maximum peers in this page (1-100); used only when listing.
array
Related data to include. roles applies only when peer_id is supplied; customfields works for list and detail.
string
Peer ID to retrieve. Omit to list peers.
string
Opaque continuation cursor returned by an earlier list call.
boolean
Include former peers; required to retrieve a peer after deactivation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_GET_ROLESList 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

integer
Maximum roles in this page (1-100); used only when listing.
string
Only list roles on this map; omit for the live map.
array
Related role data to include: holders, customfields, groups, or representing. Multiple values may be supplied.
string
Only list roles held by this peer; takes precedence over group_id.
string
Role ID to retrieve. Omit to list roles.
string
Only list roles in this group; ignored when peer_id is supplied.
string
Opaque continuation cursor returned by an earlier list call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_UNASSIGN_ROLE_HOLDERRemove one peer’s assignment from one role without deleting either the peer or the role.

Input Parameters

string
required
Peer whose role assignment to remove.
string
required
Role from which to remove the peer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_UPDATE_CUSTOM_FIELD_DEFINITIONRename 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

string
New definition name; this also changes the API key used to write custom-field values.
integer
New display order.
boolean
New public visibility state.
object
Replacement display labels keyed by supported language code.
string
required
ID of the custom-field definition to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_UPDATE_GROUPUpdate 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

string
New group name; omit to preserve it.
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.
string ("circle")
New node shape. Only circle is exposed because it is the live-verified safe value; omit to preserve the current shape.
boolean
Whether the group is external; omit to preserve it.
string
required
ID of the group to update.
object
Named custom-field values to update.
string
New parent group ID; omit to preserve it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_UPDATE_PEERUpdate selected profile fields on an existing peer; omitted fields remain unchanged despite the provider using PUT.

Input Parameters

string
required
ID of the peer to update.
string
New display nickname; omit to preserve it.
string
New last name; omit to preserve it.
string
New first name; omit to preserve it.
object
Replacement values for named custom fields included in this update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_UPDATE_ROLEUpdate selected core role properties without changing Contribution- or Goals-specific settings.

Input Parameters

string
New role name; omit to preserve it.
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.
string
required
ID of the role to update.
boolean
Whether the role is external; omit to preserve it.
object
Named custom-field values to update.
string
New parent group ID; omit to preserve it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PEERDOM_UPSERT_ROLE_HOLDEREnsure a peer holds a role, creating the assignment when absent or updating its percentage, focus, and elected-until date when present.

Input Parameters

string
Optional focus or responsibility note for the assignment.
string
required
Peer who should hold the role.
string
required
Role to assign.
number
Allocation percentage for this role; omit when no change is needed.
string
Optional election end date in YYYY-MM-DD form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not