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

Get Organization

Request

Retrieve details of a specific organization by its ID.

Security
bearerAuth
Path
idstringrequired

The unique identifier of the organization.

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/management/organizations/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-fingerprint-id: string'

Responses

Successfully retrieved organization data.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "id": "e3c76a34-91b2-4b38-9d28-41c531ef1d2a",
    "createdAt": "2025-01-10T14:20:00.000Z",
    "name": "Tech Innovators Ltda",
    "document": { … },
    "collaborator": [ … ],
    "billing": { … },
    "user": { … },
    "company": { … },
    "forecastIncome": { … }
  }
}

List user organizations

Request

Returns a paginated list of organizations associated with the authenticated user.

Security
bearerAuth
Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

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/management/organizations/list?page=string&limit=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-fingerprint-id: string'

Responses

Successfully retrieved the list of user organizations.

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

List collaborators

Request

List all businesses the collaborator is part of

Security
bearerAuth
Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

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/easyflow/businesses/list-by-collaborator?page=string&limit=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-fingerprint-id: string'

Responses

Successful retrieval of businesses for the collaborator

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

Sales

Operations

Commissions

Operations

Financial

Operations

Subscriptions

Operations