List businesses by owner

GET/business/list-businesses-by-owner

Returns all businesses associated with the owner

Request

curl --request GET \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/business/list-businesses-by-owner?page=1&limit=10' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/business/list-businesses-by-owner?page=1&limit=10', {
  method: 'GET',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
  },
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/business/list-businesses-by-owner?page=1&limit=10"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
}

response = requests.get(url, headers=headers)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "docs": [
      {
        "id": "8b1d2f4e-5a6c-4e7f-9a0b-1c2d3e4f5a6b",
        "createdAt": "2024-09-19T22:00:59.527Z",
        "name": "Acme Courses",
        "document": {
          "type": "CPF",
          "number": "12345678909"
        },
        "owner": {
          "id": "2d4f6b8d-0f2b-4d6f-8b0d-2f4b6d8f0002",
          "name": "Maria Silva",
          "document": {
            "type": "CPF",
            "number": "12345678909"
          },
          "email": "maria@example.com"
        },
        "plan": {
          "id": "5e7a9c1e-3a5c-4e9a-8c3e-5a7c9e1a000f",
          "description": "Plano básico D30",
          "name": "Basic D30",
          "status": "active",
          "isDefault": true
        },
        "bankAccounts": [
          {
            "agencyNumber": "0001",
            "agencyCheckerDigit": null,
            "accountNumber": "123456",
            "accountCheckerDigit": "7",
            "name": "Maria Silva",
            "bankCode": "001",
            "type": "checking",
            "isDefault": true,
            "externalReferenceId": "6f8b0d2f-4b6d-4f0b-8d4f-6b8d0f2b0010",
            "id": "7a9c1e3a-5c7e-4a1c-8e5a-7c9e1a3c0011",
            "pixKey": "maria@example.com",
            "pixType": "Email"
          }
        ]
      }
    ],
    "limit": 10,
    "currentPage": 1,
    "nextPage": null,
    "totalPages": 1,
    "totalDocs": 1,
    "hasNext": false
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.

Query parameters

pageintegerrequired
Page number to access

Example:1
limitintegerrequired
Number of items to be loaded per page

Example:10