⭐ If you like what we are doing with Automatisch, please give us a star on GitHub.
Automatisch

Appearance

Apps​

Retrieve an app​

GET
/v1/apps/{appKey}

Returns a specific app by its key.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Path Parameters

appKey*

Unique key of the app (e.g., slack, github)

Typestring
Required

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Retrieve all apps​

GET
/v1/apps

Returns a list of all available apps in Automatisch.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Playground​

Server
Authorization

Samples​

Executions​

Get execution by ID​

GET
/v1/executions/{executionId}

Retrieves detailed information about a specific execution.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Path Parameters

executionId*

Unique identifier of the execution

Typestring
Required

Responses​

Execution details

Playground​

Server
Authorization
Variables
Key
Value

Samples​

List executions​

GET
/v1/executions

Retrieves a filtered list of executions based on query parameters.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Query Parameters

name

Filter by execution name

Typestring
status

Filter by execution status

Typestring
Enum
successfailure
startDateTime

Filter executions that started after this timestamp (in milliseconds)

Typeinteger
formatint64
endDateTime

Filter executions that ended before this timestamp (in milliseconds)

Typeinteger
formatint64

Responses​

List of executions matching the filters

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Flows​

List flows​

GET
/v1/flows

Retrieves a list of flows, optionally filtered by query parameters.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Query Parameters

folderId

Filter by folder ID

Typestring
name

Filter by flow name

Typestring
status

Filter by flow status

Typestring
Enum
publisheddraft
userId

Filter by user ID

Typestring

Responses​

List of flows matching the filters

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Create a new flow​

POST
/v1/flows

Creates a new flow for a user. Optionally, a templateId can be provided to base the flow on an existing template.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Request Body​

JSON
{
"userId": "string",
"templateId": "string"
}

Responses​

Flow created successfully

Playground​

Server
Authorization
Body
JSON

Samples​

Get flow by ID​

GET
/v1/flows/{flowId}

Retrieves detailed information about a specific flow.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Path Parameters

flowId*

Unique identifier of the flow

Typestring
Required

Responses​

Flow details

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Delete a flow​

DELETE
/v1/flows/{flowId}

Deletes a specific flow by its ID.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Path Parameters

flowId*

Unique identifier of the flow to delete

Typestring
Required

Responses​

Flow deleted successfully

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Update flow status​

PATCH
/v1/flows/{flowId}/status

Enables or disables a flow by setting its active status.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Path Parameters

flowId*

Unique identifier of the flow

Typestring
Required

Request Body​

JSON
{
"active": true
}

Responses​

Flow status updated

Playground​

Server
Authorization
Variables
Key
Value
Body
JSON

Samples​

Templates​

List templates​

GET
/v1/templates

Retrieves a list of all flow templates.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Responses​

List of templates

Playground​

Server
Authorization

Samples​

Create a new template​

POST
/v1/templates

Creates a new flow template using an existing flow.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Request Body​

JSON
{
"name": "string",
"flowId": "string"
}

Responses​

Template created successfully

Playground​

Server
Authorization
Body
JSON

Samples​

Get template by ID​

GET
/v1/templates/{templateId}

Retrieves detailed information about a specific template.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Path Parameters

templateId*

Unique identifier of the template

Typestring
Required

Responses​

Template details

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Delete a template​

DELETE
/v1/templates/{templateId}

Deletes a specific template by its ID.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Path Parameters

templateId*

Unique identifier of the template to delete

Typestring
Required

Responses​

Template deleted successfully

Playground​

Server
Authorization
Variables
Key
Value

Samples​

User Invitations​

List user invitations​

GET
/user-invitations

Retrieves a paginated list of user invitations.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Query Parameters

page

Page number for pagination

Typeinteger

Responses​

List of user invitations

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Create user invitation​

POST
/user-invitations

Sends a new user invitation.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Request Body​

JSON
{
"fullName": "string",
"email": "string",
"roleId": "string"
}

Responses​

User invitation created successfully

Playground​

Server
Authorization
Body
JSON

Samples​

Delete user invitation​

DELETE
/user-invitations/{userId}

Deletes a specific user invitation.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Path Parameters

userId*

Unique identifier of the user invitation to delete

Typestring
Required

Responses​

User invitation deleted successfully

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Folders​

List folders for user​

GET
/users/{userId}/folders

Retrieves all folders belonging to a specific user.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Path Parameters

userId*

Unique identifier of the user

Typestring
Required

Responses​

List of folders

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Create folder for user​

POST
/users/{userId}/folders

Creates a new folder for a specific user.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Path Parameters

userId*

Unique identifier of the user

Typestring
Required

Request Body​

JSON
{
"name": "string"
}

Responses​

Folder created successfully

Playground​

Server
Authorization
Variables
Key
Value
Body
JSON

Samples​

Delete folder​

DELETE
/users/{userId}/folders/{folderId}

Deletes a specific folder for a given user.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Path Parameters

userId*

Unique identifier of the user

Typestring
Required
folderId*

Unique identifier of the folder

Typestring
Required

Responses​

Folder deleted successfully

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Users​

Get user by ID​

GET
/users/{userId}

Retrieves details of a specific user.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Path Parameters

userId*

Unique identifier of the user

Typestring
Required

Responses​

User details

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Delete a user​

DELETE
/users/{userId}

Deletes a specific user by ID.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Path Parameters

userId*

Unique identifier of the user

Typestring
Required

Responses​

User deleted successfully

Playground​

Server
Authorization
Variables
Key
Value

Samples​

List users​

GET
/users

Retrieves a paginated list of users.

Authorizations​

ApiKeyAuth
TypeAPI Key (header: x-api-token)

Parameters​

Query Parameters

page

Page number for pagination

Typeinteger

Responses​

List of users

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Copyright © 2022 Automatisch. All rights reserved.