Skip to main content
Manager-scoped endpoints give you control over signing packages at the locations you manage, as well as read access to the organizational hierarchy (organizations → companies → locations) that underpins them. All endpoints in this group require a valid Clerk session JWT and enforce RBAC based on your signing session’s module access tiers. Access is determined by two factors: your module tier (from caps.manager.signings, caps.manager.flows, etc.) and your location scope (which locations your manager employee memberships grant access to). Admin users bypass the location scope check and instead receive global access, capped at 500 rows per list response. Check caps.manager or caps.admin in your session payload before calling these routes. The relevant tiers are documented on each endpoint below.

Organizations

List organizations

Returns all organizations in your scope. Managers see only organizations they have been granted access to through their role memberships. Admins see all organizations globally, capped at 500 rows.
This endpoint is at /v1/signing/organizations (not under /v1/signing/manager/). It uses the same session RBAC as other manager endpoints but is also accessible to admins.
No query parameters.

Response

array
required
Array of organization records in your scope.
string
required
Either "managed" (manager, scoped to your employee memberships) or "global" (admin, all organizations).

Error responses


Companies

List companies

Returns companies visible to you, optionally filtered by organization. Managers see only companies belonging to their accessible organizations. Admins see all companies (capped at 500).
This endpoint is at /v1/signing/companies (not under /v1/signing/manager/).
string
Numeric organization ID to filter by. If you are a manager and specify an organization you do not have access to, the request returns 403.

Response

array
required
Array of company records.
string
required
"managed" or "global".

Error responses


Get one company

Returns a single company record. The company must be within your accessible scope.
Required tier: any of signings, templates, or flows at "read" or above, or admin.
string
required
Numeric company ID.

Response

The company record for the requested company.

Error responses


Locations

List locations

Returns locations under your accessible companies, optionally filtered by company. Admins receive all locations globally (capped at 500). Results are ordered by name ascending.
Required tier: any of signings, templates, or flows at "read" or above, or admin.
string
Numeric company ID to filter by. Managers specifying a company outside their scope receive 403.

Response

array
required
Array of location records.
string
required
"managed" or "global".

Error responses


Get one location

Returns a single location record. The location’s parent company must be within your scope.
Required tier: any of signings, templates, or flows at "read" or above, or admin.
string
required
Numeric location ID.

Response

The location record for the requested location.

Error responses


Signing packages

List signing packages

Returns signing packages for the locations in your scope, ordered by updatedAt descending. Managers can optionally filter to one location. Admins receive packages globally (capped at 500).
Required tier: signings at "read" or above, or admin.
string
Numeric location ID to filter by. Managers specifying a location outside their scope receive 403.

Response

array
required
Array of signing package records.
string
required
"managed" or "global".

Error responses


Get one signing package

Returns a single signing package record. The package’s location must be in your scope.
Required tier: signings at "read" or above, or admin.
string
required
Numeric signing package ID.

Response

The signing package record for the requested package.

Error responses


List documents in a package

Returns all documents in the package, ordered by position ascending then id ascending, capped at 500.
Required tier: signings at "read" or above, or admin.
string
required
Numeric signing package ID.

Response

array
required
Array of document records for this package.

Error responses


List signers in a package

Returns the roster of signer records for the package, ordered by signer number ascending, capped at 200.
Required tier: signings at "read" or above, or admin.
string
required
Numeric signing package ID.

Response

array
required
Array of signer records for this package.

Error responses


Create a signing package

Creates a new signing package in draft status at the specified location. The package has no documents or signers attached at creation time; those are added through subsequent operations.
Required tier: signings at "write" or above, or admin.
string
required
Numeric ID of the location where this package is being created. You must have access to this location.
string
Numeric ID of the signing flow to associate with this package. The flow must belong to the same location as locationId—a mismatch returns 400.
string
A free-text note for this package. Maximum 4000 characters. Leading and trailing whitespace is trimmed before storage.

Response

The newly created signing package record with status: "draft".

Error responses


Cancel a signing package

Sets the package’s status to "cancelled" and optionally records a cancellation reason. The package’s location must be in your scope.
Required tier: signings at "write" or above, or admin.
string
required
Numeric signing package ID.
string
Human-readable reason for cancellation. Maximum 2000 characters. Stored in the message field on the signing row. If omitted, the existing message value is preserved, or "Cancelled by manager." is set as a default.
If the package is already in a cancelled or canceled status, this endpoint returns 409. Check the current status field before calling this endpoint if you want to avoid that error.

Response

object
required
The updated signing package record with status: "cancelled".

Error responses


Resend signing notifications

Triggers re-delivery of signer notifications for this package. The package’s location must be in your scope.
Required tier: signings at "write" or above, or admin.
string
required
Numeric signing package ID.
No request body.

Response

boolean
required
true when the resend job was successfully enqueued.
any
The result returned by the integration queue after enqueuing the job.

Error responses