Evisort

OpenAPI specification for Evisort API for integration with 3rd party services

[Terms of Service](https://evisort.com/api/terms)

Evisort Admin API

authentication

Generate a new token using the public API key

Generate a new token

List users, and bulk export/import via spreadsheet

users

Export users spreadsheet for current client

Import users spreadsheet

List Import users jobs

Import Process status

Generate a summary of a users import operation

Request the acknowledge of a user import process

Request the cancellation of a user import process

Import Process Errors Results spreadsheets

Import Summary Errors Results spreadsheets

List users for current client. Choose at most one primary filter (filter[id], filter[email], filter[department]); filter[includeDeleted] stacks on any or stands alone. Unknown filter keys or two primary filters → 400. Always paginated. Requires an admin (or super-admin) JWT and the LaunchDarkly flag `public-acl-api-ekp-55221`.


List users

Manage departments — create, list, read, update, delete, and membership. ACL endpoints require an admin (or super-admin) JWT and the LaunchDarkly flag `public-acl-api-ekp-55221`. Missing the flag or a non-admin caller → 403 FORBIDDEN.


departments

Create one department. name is 1..1000 chars after trim and cannot contain '//'; it must be unique among siblings (case-sensitive). parentDepartment is a department ID; omit or null for top-level. Sub-departments do not inherit grants or members. Returns a Location header; the body has name, parentDepartment, and path only.


Create a department

Browse the department tree. filter[id]=X returns the children of X (not X itself; use GET /v2/admin/departments/{id} for a single dept). filter[path] resolves a department by path. filter[id] and filter[path] are mutually exclusive. depth (default 1, max 100) controls how many levels below the anchor to include. Sorted by case-insensitive name, then id. Always paginated.


List departments

Read a single department by ID. Returns name, parentDepartment, path, depth (absolute level, 1 for top-level), and memberCount (direct members only). Unknown, already deleted, or cross-tenant → 404 DEPARTMENT_NOT_FOUND.


Read a department

Rename and/or re-parent a department; at least one of name or parentDepartment is required (empty → 400 DEPARTMENT_PATCH_EMPTY). parentDepartment: omit to keep, null to promote to top-level, or an ID to re-parent (cannot be self or a descendant → 400 DEPARTMENT_REPARENT_CYCLE). IDs are stable, so grants and member links survive. Name validation matches POST. Idempotent. The body has name, parentDepartment, and path only.


Update a department (config only)

Delete a department and its subtree (descendant departments, their folder grants, and membership links); users themselves are never deleted. Async — returns 202 + JobAck (status queued only; no kind); poll GET /v2/admin/jobs/{jobId} for kind department.delete and the outcome. Idempotent and tenant-blind: an unknown, cross-tenant, or already-deleted id returns the same 202 no-op (no 404).


Delete a department (async, cascades)

Add or remove department members (one op per request) by user ID. members is 1..500 IDs after dedupe. Async — returns 202 + JobAck; poll GET /v2/admin/jobs/{jobId} for per-ID outcomes. Idempotent (re-add or remove-non-member is a no-op success); unknown/cross-tenant user IDs surface as USER_NOT_FOUND in outcome.failed[], not here. An unknown {departmentId} → 404 DEPARTMENT_NOT_FOUND (no job created).


Update department members (async)

Read and set access controls on folders (extensible to documents and fields). ACL endpoints require an admin (or super-admin) JWT and the LaunchDarkly flag `public-acl-api-ekp-55221`. Missing the flag or a non-admin caller → 403 FORBIDDEN.


access

Async, atomic, single-op folder ACL mutation. Returns 202 + JobAck; outcome via GET /v2/admin/jobs/{jobId} (binary: succeeded or failed). Identify the folder with data.id and/or data.path (both must agree, or 400 FOLDER_REFERENCE_MISMATCH; neither → 400 FOLDER_REFERENCE_MISSING). data.attributes must hold exactly one of visibilityLevel, grant, or revoke; grant/revoke targets exactly one of department or user. Grants are additive and only meaningful on RESTRICTED folders; re-grant, revoke-non-grantee, and no-op visibility changes all succeed. Sync rejections (no job created): tenant root → 400 ROOT_FOLDER_NOT_PATCHABLE; unknown folder/user/department → 404; data.type ≠ folder → 409.


Update folder ACL (async)

Sync read of a folder's ACL. Requires filter[type]=folder plus exactly one of filter[id] / filter[path]. Optionally narrow accessList to one principal with filter[department] or filter[user] (mutually exclusive, literal — no derived grants). accessList is empty on OPEN* folders and capped at meta.accessListLimit (meta.accessListTruncated flags overflow).


Read folder ACL

Read status and outcome of async submissions (`PATCH /v2/admin/access`, `PATCH /v2/admin/departments/{departmentId}/members`, `DELETE /v2/admin/departments/{departmentId}`, `POST /v2/admin/role-assignments`). Requires an admin (or super-admin) JWT and the LaunchDarkly flag `public-acl-api-ekp-55221`.


async-jobs

Read the status and outcome of an async submission (access, members, department delete, or role-assignments). attributes.kind discriminates the job type; outcome.applied[] holds successful sub-ops and outcome.failed[] holds per-row failure objects (JSON:API errors for members/access/department.delete; `{ userId, roleId, code }` for role-assignments.update). Lifecycle: queued → running → succeeded | partial_success | failed. partial_success applies to members.update, role-assignments.update (per-row failures), and department.delete (subtree deleted but ACL regeneration failed). access.update is binary (succeeded or failed). Unknown, malformed, or cross-tenant jobId → 404 JOB_NOT_FOUND.


Read async job status

Discover tenant-owned custom role IDs (e.g. to build a bulk role-assignment request). Read-only — does not expose role creation, editing, deletion, or the permission catalog. ACL endpoints require an admin (or super-admin) JWT and the LaunchDarkly flag `public-acl-api-ekp-55221`. Missing the flag or a non-admin caller → 403 FORBIDDEN.


roles

Discover the tenant's live custom role IDs, e.g. to build a bulk role-assignment request. `filter[type]=custom` is required and is currently the only accepted value — prebuilt roles (Owner, Administrator, Power user, Workflow-only, …) are not tenant-owned and are never returned by this endpoint. Sorted by case-insensitive name, then id. Always paginated.


List custom roles

Bulk-replace user role assignments (async). On Workday-managed tenants, each accepted mapping is also synced to Rolodex (role-only); a row is reported applied only once both Pilot and Rolodex accept. Evisort-managed tenants skip Rolodex. ACL endpoints require an admin (or super-admin) JWT and the LaunchDarkly flag `public-acl-api-ekp-55221`. Missing the flag or a non-admin caller → 403 FORBIDDEN.


role-assignments

Replace each listed user's role with the given custom `roleId` (Authzed role-replace). `assignments` is 1..500 rows; each `userId` may appear only once. Async — returns 202 + JobAck; poll `GET /v2/admin/jobs/{jobId}` (`kind: role-assignments.update`) for per-row outcomes. Idempotent when the user already holds the target role (`result: unchanged`). On Workday-managed tenants the worker also syncs the role to Rolodex (role-only); a row is reported `applied` only after both Pilot and Rolodex accept the role. Evisort-managed tenants skip Rolodex. Rolodex sync failures surface as `ROLE_UPDATE_FAILED` in `outcome.failed[]` (no Rolodex detail is returned); resubmitting the same mapping heals Rolodex without duplicating Pilot writes or audit entries. Unknown users, unknown/non-custom roles, and forbidden role changes land in `outcome.failed[]` as `{ userId, roleId, code }` (not full JSON:API errors); sync 400s below create no job.


Bulk-replace user roles (async)

Default

Prod - Admin

Production

Sandbox

OpenAPI specification for Evisort API for integration with 3rd party services<a href="https://evisort.com/api/terms" target="_self">Terms of Service</a>

OpenAPI specification for Evisort API for integration with 3rd party services

OpenAPI specification for Evisort API for integration with 3rd party services Terms of Service

Generate Access Token (JWT)

List users, and bulk export/import via spreadsheet

Export users spreadsheet for current client

Authorization

Boolean flag that determines whether to export the complete spreadsheet or only the headers. If not defined, it defaults to false.

only_headers

response

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

error

Import users spreadsheet

String GUID that determines the id of the current Import summary and process. This identifier identifies each file.

import_id

Boolean flag that determines whether to send an email to new users or not (non existing users in the DB, but present in the spreadsheet). If not defined, it defaults to false.

email_new_users

Boolean flag that determines whether to update existing users or not (already existing users in the DB). If not defined, it defaults to false.

update_existing_users

Boolean flag that determines whether to delete missing users or not (users in the DB but not in the spreadsheet). If not defined, it defaults to false.

delete_missing_users

Number that determines the id of the current Client.

client_id

String GUID that determines the id of the celery task.

task_id

Specify the page number of paginated results to return

page

pageSize

imports

count

importId

Number that determines the id of the import process.

Number that determines the id of the user that created the import process.

user_id

status

Indicates whether the import process has been requested to be acknowledged.

acknowledged

timestamps

counters

file

results

List users for current client. Choose at most one primary filter (filter[id], filter[email], filter[department]); filter[includeDeleted] stacks on any or stands alone. Unknown filter keys or two primary filters → 400. Always paginated. Requires an admin (or super-admin) JWT and the LaunchDarkly flag <code class="slate-code">public-acl-api-ekp-55221</code>.

List users for current client. Choose at most one primary filter (filter[id], filter[email], filter[department]); filter[includeDeleted] stacks on any or stands alone. Unknown filter keys or two primary filters → 400. Always paginated. Requires an admin (or super-admin) JWT and the LaunchDarkly flag 

Exact user ID. Mutually exclusive with the other primary filters.

filter[id]

Exact email, case-insensitive. Mutually exclusive with the other primary filters.

filter[email]

Exact department ID; direct members only. Mutually exclusive with the other primary filters.

filter[department]

Include soft-deleted users. Default false. Only the literal strings true/false are accepted.

filter[includeDeleted]

1-indexed page number for paginated ACL results.

page[number]

Number of items per page for paginated ACL results (max 200).

page[size]

data

Absolute URLs for navigating paginated collections.

links

singleUserLookup

Single hit — exact `filter[id]` lookup shown; `filter[email]` returns the same shape

byEmail

`?filter[email]=alice@example.com` — exact, case-insensitive; ≤1 result

byDepartment

`?filter[department]=43` — direct members of dept ID `43`, paginated

includingDeleted

`?filter[includeDeleted]=true` — modifier stacks on any filter; soft-deleted shown with `isDeleted: true`

noResults

Unknown id/email — empty result, no existence leak

errors

Validation failed — see examples for operation-specific codes.

userFilterAmbiguous

More than one of `filter[id]` / `filter[email]` / `filter[department]` on `GET /v2/admin/users/search`

invalidQueryParam

Multi-value or repeated `filter[…]` / `page[…]` parameter

unknownFilterKey

Unknown `filter[X]` key — only declared filters are accepted

multiFieldValidationErrors

Multiple field-level errors reported in one envelope (no fail-fast)

Unauthorized

Authenticated but not permitted — caller is not an admin/super-admin, or the LaunchDarkly flag `public-acl-api-ekp-55221` is off.


Forbidden

Internal Server Error

List users for current client. Choose at most one primary filter (filter[id], filter[email], filter[department]); filter[includeDeleted] stacks on…

Manage departments — create, list, read, update, delete, and membership. ACL endpoints require an admin (or super-admin) JWT and the LaunchDarkly flag <code class="slate-code">public-acl-api-ekp-55221</code>. Missing the flag or a non-admin caller → 403 FORBIDDEN.

Manage departments — create, list, read, update, delete, and membership. ACL endpoints require an admin (or super-admin) JWT and the LaunchDarkly flag 

. Missing the flag or a non-admin caller → 403 FORBIDDEN.

Manage departments — create, list, read, update, delete, and membership. ACL endpoints require an admin (or super-admin) JWT and the LaunchDarkly…

Read and set access controls on folders (extensible to documents and fields). ACL endpoints require an admin (or super-admin) JWT and the LaunchDarkly flag <code class="slate-code">public-acl-api-ekp-55221</code>. Missing the flag or a non-admin caller → 403 FORBIDDEN.

Read and set access controls on folders (extensible to documents and fields). ACL endpoints require an admin (or super-admin) JWT and the LaunchDarkly flag 

Read and set access controls on folders (extensible to documents and fields). ACL endpoints require an admin (or super-admin) JWT and the…

Read status and outcome of async submissions (<code class="slate-code">PATCH /v2/admin/access</code>, <code class="slate-code">PATCH /v2/admin/departments/{departmentId}/members</code>, <code class="slate-code">DELETE /v2/admin/departments/{departmentId}</code>, <code class="slate-code">POST /v2/admin/role-assignments</code>). Requires an admin (or super-admin) JWT and the LaunchDarkly flag <code class="slate-code">public-acl-api-ekp-55221</code>.

Read status and outcome of async submissions (

PATCH /v2/admin/departments/{departmentId}/members

DELETE /v2/admin/departments/{departmentId}

). Requires an admin (or super-admin) JWT and the LaunchDarkly flag 

Read status and outcome of async submissions ( PATCH /v2/admin/access , PATCH /v2/admin/departments/{departmentId}/members , DELETE…

Discover tenant-owned custom role IDs (e.g. to build a bulk role-assignment request). Read-only — does not expose role creation, editing, deletion, or the permission catalog. ACL endpoints require an admin (or super-admin) JWT and the LaunchDarkly flag <code class="slate-code">public-acl-api-ekp-55221</code>. Missing the flag or a non-admin caller → 403 FORBIDDEN.

Discover tenant-owned custom role IDs (e.g. to build a bulk role-assignment request). Read-only — does not expose role creation, editing, deletion, or the permission catalog. ACL endpoints require an admin (or super-admin) JWT and the LaunchDarkly flag 

Discover tenant-owned custom role IDs (e.g. to build a bulk role-assignment request). Read-only — does not expose role creation, editing, deletion,…

Bulk-replace user role assignments (async). On Workday-managed tenants, each accepted mapping is also synced to Rolodex (role-only); a row is reported applied only once both Pilot and Rolodex accept. Evisort-managed tenants skip Rolodex. ACL endpoints require an admin (or super-admin) JWT and the LaunchDarkly flag <code class="slate-code">public-acl-api-ekp-55221</code>. Missing the flag or a non-admin caller → 403 FORBIDDEN.

Bulk-replace user role assignments (async). On Workday-managed tenants, each accepted mapping is also synced to Rolodex (role-only); a row is reported applied only once both Pilot and Rolodex accept. Evisort-managed tenants skip Rolodex. ACL endpoints require an admin (or super-admin) JWT and the LaunchDarkly flag 

Bulk-replace user role assignments (async). On Workday-managed tenants, each accepted mapping is also synced to Rolodex (role-only); a row is…

Sections