Skip to content

Easyflow (1.0)

Easyflow API Document

This is the API documentation and must be used by everyone who wants to integrate with the Easyflow platform.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Languages
Servers
Mock server
https://mobile-docs.easyflow.digital/_mock/openapi
Production environment URL
https://wz0ppvhzw7.execute-api.sa-east-1.amazonaws.com

Authentication

Operations

Users

Operations

Organizations

Operations

Sales

Operations

Commissions

Operations

Financial

Operations

Subscriptions

Operations

Notifications

Operations

Add device for notifications

Request

Add a new device to enable communication and push notification delivery for the authenticated user.

Security
bearerAuth
Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

Bodyapplication/jsonrequired
deviceIdstringrequired

Unique identifier of the device.

Example: "device-9f8c1a"
platformstringrequired

Platform where the device is running.

Enum"android""ios""web"
Example: "ios"
environmentstringrequired

Application environment where the device is registered.

Example: "production"
pushTokenstringrequired

Push notification token generated by the platform provider.

Example: "eJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.mocktoken"
mobileSettingsobject

Mobile-specific device settings. Required for mobile platforms.

webSettingsobject

Web-specific device settings. Required for web platform.

curl -i -X POST \
  https://mobile-docs.easyflow.digital/_mock/openapi/notifications/devices/add-device \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-fingerprint-id: string' \
  -d '{
    "deviceId": "device-9f8c1a",
    "platform": "ios",
    "environment": "production",
    "pushToken": "eJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.mocktoken",
    "mobileSettings": {
      "appInstanceId": "app-instance-8831",
      "appVersion": "3.1.0",
      "osVersion": "17.2",
      "deviceModel": "iPhone 15"
    },
    "webSettings": {
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X)",
      "ipAddress": "192.168.0.10"
    }
  }'

Responses

Device successfully registered

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "device": { … }
  }
}

Refresh device push token

Request

Update the push notification token associated with an existing device for the authenticated user.

Security
bearerAuth
Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

Bodyapplication/jsonrequired
deviceIdstringrequired

Unique identifier of the device whose token will be updated.

Example: "device-a81f92"
pushTokenstringrequired

New push notification token generated by the platform provider.

Example: "eJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.newmocktoken123"
curl -i -X POST \
  https://mobile-docs.easyflow.digital/_mock/openapi/notifications/devices/refresh-token \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-fingerprint-id: string' \
  -d '{
    "deviceId": "device-a81f92",
    "pushToken": "eJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.newmocktoken123"
  }'

Responses

Device push token successfully updated

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "device": { … }
  }
}

Update device

Request

Update device information and settings used for communication and notification delivery for the authenticated user.

Security
bearerAuth
Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

Bodyapplication/jsonrequired
idstringrequired

Unique identifier of the device to be updated.

Example: "65dcb3c41a9f8e0023a9b551"
environmentstring

Application environment associated with the device.

Example: "production"
statusstring

Current device status.

Enum"active""revoked"
Example: "active"
pushTokenstring

Updated push notification token.

Example: "eJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.updatedmocktoken789"
mobileSettingsobject

Mobile-specific settings to be updated.

webSettingsobject

Web-specific settings to be updated.

curl -i -X PATCH \
  https://mobile-docs.easyflow.digital/_mock/openapi/notifications/devices/update \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-fingerprint-id: string' \
  -d '{
    "id": "65dcb3c41a9f8e0023a9b551",
    "environment": "production",
    "status": "active",
    "pushToken": "eJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.updatedmocktoken789",
    "mobileSettings": {
      "appInstanceId": "app-instance-9912",
      "appVersion": "4.0.2",
      "osVersion": "18.1",
      "deviceModel": "Samsung Galaxy S24"
    },
    "webSettings": {
      "userAgent": "Mozilla/5.0 (X11; Linux x86_64)",
      "ipAddress": "172.16.10.25"
    }
  }'

Responses

Device successfully updated

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "device": { … }
  }
}

List user devices

Request

Retrieve a paginated list of devices registered for the authenticated user, used for communication and notification delivery.

Security
bearerAuth
Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

userIdstring

Filter devices by user identifier.

Example: userId=9f2a7c31-6d4e-4d9a-b5e8-1f7c9e4a2b10
Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

curl -i -X GET \
  'https://mobile-docs.easyflow.digital/_mock/openapi/notifications/devices?page=string&limit=string&userId=9f2a7c31-6d4e-4d9a-b5e8-1f7c9e4a2b10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-fingerprint-id: string'

Responses

Successful response with a paginated list of user devices

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "docs": [ … ],
    "limit": 10,
    "currentPage": 1,
    "hasNext": false,
    "nextPage": 0,
    "totalDocs": 1,
    "totalPages": 1
  }
}

Get device details

Request

Retrieve detailed information about a specific device registered for communication and notification delivery.

Security
bearerAuth
Query
idstring

Unique internal identifier of the device.

Example: id=65dcb7e41f8c9d0025d9a331
deviceIdstring

External identifier associated with the device.

Example: deviceId=device-f3a91c
Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

curl -i -X GET \
  'https://mobile-docs.easyflow.digital/_mock/openapi/notifications/devices/get?id=65dcb7e41f8c9d0025d9a331&deviceId=device-f3a91c' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-fingerprint-id: string'

Responses

Successful response with device details

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "device": { … }
  }
}

Acknowledge notification read

Request

Confirm the reading of one or more notifications for the authenticated user.

Security
bearerAuth
Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

Bodyapplication/jsonrequired
notificationIdsArray of stringsrequired

List of notification identifiers to be marked as read.

Example: ["65dcc91b2a7f4c0026b9a441","65dcc91b2a7f4c0026b9a442"]
curl -i -X PATCH \
  https://mobile-docs.easyflow.digital/_mock/openapi/notifications/notifications/ack-read \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-fingerprint-id: string' \
  -d '{
    "notificationIds": [
      "65dcc91b2a7f4c0026b9a441",
      "65dcc91b2a7f4c0026b9a442"
    ]
  }'

Responses

Notifications successfully marked as read

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "success": true
  }
}

Delete notifications

Request

Delete one or more notifications for the authenticated user.

Security
bearerAuth
Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

Bodyapplication/jsonrequired
notificationIdsArray of stringsrequired

List of notification identifiers to be deleted.

Example: ["65dccb3a9f2e4a0027c1d551","65dccb3a9f2e4a0027c1d552"]
curl -i -X PATCH \
  https://mobile-docs.easyflow.digital/_mock/openapi/notifications/notifications/delete \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-fingerprint-id: string' \
  -d '{
    "notificationIds": [
      "65dccb3a9f2e4a0027c1d551",
      "65dccb3a9f2e4a0027c1d552"
    ]
  }'

Responses

Notifications successfully deleted

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "success": true
  }
}

Get notification details

Request

Retrieve detailed information about a specific notification for the authenticated user.

Security
bearerAuth
Path
notificationIdstringrequired

Unique identifier of the notification to retrieve.

Example: 65dcd1f42b9a4e0028e7c991
Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

curl -i -X GET \
  https://mobile-docs.easyflow.digital/_mock/openapi/notifications/notifications/65dcd1f42b9a4e0028e7c991 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-fingerprint-id: string'

Responses

Successful response with notification details

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "id": "65dcd1f42b9a4e0028e7c991",
    "createdAt": "2026-01-25T14:22:10.430Z",
    "updatedAt": "2026-01-29T18:32:44.880Z",
    "deleted": "string",
    "userId": "e7b21f3a-1f4a-49b2-9c77-0e1a9b3d7a55",
    "status": "read",
    "deviceId": "device-7a91c2",
    "templateId": "65dccf1b912671528d111aaa",
    "idempotencyKey": "7c91f1b9e4c640c5a2d39c8b77f4e2a15a6b9f33e8b1c0d7a9e4b1c2d3f9a01",
    "payload": { … },
    "log": { … }
  }
}

List notifications

Request

Retrieve a paginated list of notifications for the authenticated user, with optional filters by status, channel, and date range.

Security
bearerAuth
Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

statusstring

Filter notifications by status.

Enum"queued""sending""sent""delivered""failed""retrying""dropped""canceled""read"
Example: status=read
channelstring

Filter notifications by delivery channel.

Enum"email""sms""web-push""mobile-push""whatsapp""*"
Example: channel=web-push
startDatestring(date-time)

Filter notifications created from this date (inclusive).

Example: startDate=2026-01-01T00:00:00.000Z
endDatestring(date-time)

Filter notifications created until this date (inclusive).

Example: endDate=2026-01-31T23:59:59.999Z
Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

curl -i -X GET \
  'https://mobile-docs.easyflow.digital/_mock/openapi/notifications/notifications?page=string&limit=string&status=read&channel=web-push&startDate=2026-01-01T00%3A00%3A00.000Z&endDate=2026-01-31T23%3A59%3A59.999Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-fingerprint-id: string'

Responses

Successful response with a paginated list of notifications

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "docs": [ … ]
  }
}

List notification summaries

Request

Rota responsável por listar os resumos das notificações do usuário com filtros por status, canal, categoria e período.

Security
bearerAuth
Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

statusstring

Filtro por status da notificação.

Enum"queued""sending""sent""delivered""failed""retrying""dropped""canceled""read"
channelstring

Filtro por canal da notificação.

Enum"email""sms""web-push""mobile-push""whatsapp""*"
categorystring

Filtro por categoria da notificação.

Enum"promotions""updates""alerts""newsletters""internal""*"
startDatestring(date-time)

Data inicial do período.

endDatestring(date-time)

Data final do período.

Headers
fingerprintstringrequired

Identificador único do dispositivo.

curl -i -X GET \
  'https://mobile-docs.easyflow.digital/_mock/openapi/notifications/notifications/summary?page=string&limit=string&status=queued&channel=email&category=promotions&startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'fingerprint: string'

Responses

Lista de resumos retornada com sucesso.

Bodyapplication/json
statusCodenumber
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "docs": [ … ],
    "limit": 10,
    "currentPage": 1,
    "hasNext": true,
    "nextPage": 2,
    "totalDocs": 120,
    "totalPages": 12
  }
}