Evisort

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

Evisort Admin API

authentication

Generate a new token using the public API key

Generate a new token

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

Default

Prod - Admin

Production

Sandbox

API tokens are used to authenticate requests to Evisort APIs. When calling an API endpoint, you must supply a valid API token in the HTTP Authorization header, with a valid token specified as the header value. You need to prefix the value with the Bearer identifier, which is required for the authentication scheme that Evisort uses.

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 spreadsheetNote that the <code class="slate-code">import_id</code> required in the payload needs to be generated from a successful call to the POST /users/import/summary endpoint (see section on “Generate a summary of a users import operation”).

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.

Sections