Skip to content

Actors

Actors are anyone or anything that does work in an organization. See Actors & Responsibilities for the conceptual model. This page is the tool reference.

Create a person or automation actor in an organization.

ParameterTypeRequiredDescription
organization_idstringyesThe organization this actor belongs to
typeenumyesperson or automation
namestringyesDisplay name
descriptionstringnoFree-form description
notesstringnoInternal notes (private workings, hiring rationale, etc.)
placeholderbooleannotrue for unfilled roles (person only). Default false
user_idstringnoLink to a registered Portuni user (person only)

Returns: { actor_id, organization_id, type, name, placeholder }

Update any of the fields above. Returns the updated actor.

ParameterTypeRequiredDescription
actor_idstringyesActor ID
namestringnoNew display name
descriptionstringnoNew description
notesstringnoNew notes
placeholderbooleannoToggle placeholder status
user_idstringnoSet or clear the linked Portuni user

List actors with optional filters.

ParameterTypeRequiredDescription
organization_idstringnoFilter to one organization
typeenumnoperson or automation
placeholderbooleannoFilter by placeholder status

Returns: array of actor records.

Get a single actor with their responsibility assignments across every node.

ParameterTypeRequiredDescription
actor_idstringyesActor ID

Returns the actor record plus an assignments array – one entry per (responsibility, node) pair the actor holds. Useful for “what is this person on the hook for across the org.”

Hard-delete an actor and cascade-delete every responsibility assignment they hold. The responsibility itself stays – only the assignment is removed.

ParameterTypeRequiredDescription
actor_idstringyesActor ID

There is no soft-delete. Archiving is final. If you might want the actor back, update them to a placeholder instead.

Attach an actor to a responsibility. Idempotent – re-assigning the same (responsibility, actor) pair is a no-op, not an error.

ParameterTypeRequiredDescription
responsibility_idstringyesResponsibility ID
actor_idstringyesActor ID

Remove an actor from a responsibility.

ParameterTypeRequiredDescription
responsibility_idstringyesResponsibility ID
actor_idstringyesActor ID