Get customers

GET/customers/{customerId}

Returns the details of a customer.

Request

curl --request GET \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/customers/CUSTOMER_ID' \
  --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/customers/CUSTOMER_ID', {
  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/customers/CUSTOMER_ID"
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": {
    "customer": {
      "business": {
        "bankAccounts": [],
        "attachments": [],
        "collaborators": [],
        "id": "8b1d2f4e-5a6c-4e7f-9a0b-1c2d3e4f5a6b",
        "name": "Example Store",
        "owner": {},
        "plan": {}
      },
      "user": null,
      "id": "6650f1a2b3c4d5e6f7a8b9c0",
      "createdAt": "2026-01-15T12:00:00.000Z",
      "updatedAt": "2026-01-15T12:00:00.000Z",
      "deleted": false,
      "name": "Maria Silva",
      "email": "maria@example.com",
      "phone": {
        "areaCode": "+55",
        "ddd": "11",
        "number": "912345678",
        "isMobile": true
      },
      "address": {
        "zipCode": "01001000",
        "street": "Rua Exemplo",
        "number": "100",
        "complement": "Apto 12",
        "neighborhood": "Centro",
        "city": "São Paulo",
        "state": "SP"
      },
      "deliveryAddress": {
        "zipCode": "01001000",
        "street": "Rua Exemplo",
        "number": "100",
        "complement": "Apto 12",
        "neighborhood": "Centro",
        "city": "São Paulo",
        "state": "SP"
      },
      "document": {
        "type": "CPF",
        "number": "12345678909"
      }
    }
  }
}

{
  "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": 404,
  "message": "Customer not found",
  "error": "Not Found"
}

{
  "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.

Path parameters

customerIdstringrequired

Responses

200returns the details of a customer

returns the details of a customer

Content typeapplication/jsonobject

statusCodeinteger
Example:200
dataobject
Show child attributesHide child attributes
- customerobject
  Show child attributesHide child attributes
  businessobject
  Show child attributesHide child attributes
  bankAccountsarray of objects
  attachmentsarray of objects
  collaboratorsarray of objects
  idstring
  namestring
  ownerobject
  planobject
  usernull
  idstring
  createdAtstring
  updatedAtstring
  deletedAtstring
  deletedboolean
  namestring
  emailstring
  phoneobject
  Show child attributesHide child attributes
  areaCodestring
  dddstring
  numberstring
  isMobileboolean
  addressobject
  Show child attributesHide child attributes
  zipCodestring
  streetstring
  numberstring
  complementstring
  neighborhoodstring
  citystring
  statestring
  The state must send an abbreviation (Example: sp)
  
  deliveryAddressobject
  Show child attributesHide child attributes
  zipCodestring
  streetstring
  numberstring
  complementstring
  neighborhoodstring
  citystring
  statestring
  The state must send an abbreviation (Example: sp)
  
  documentobject
  Show child attributesHide child attributes
  typestring
  Possible values:CPFCNPJ
  numberstring

400If the provided parameter is invalid, the API will return the following error response:

If the provided parameter is invalid, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Invalid param: []

Example:Invalid param: []
errorstring
Bad Request

Example:Bad Request
statusCodeinteger
400

Example:400
errorCodestring
Code that identifies the error. Present only on some errors.

401If the request is unauthorized, the API will return the following error response:

If the request is unauthorized, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Invalid field

Example:Unauthorized
errorstring
Unauthorized

Example:Unauthorized
statusCodeinteger
401

Example:401

403If the request is forbidden, the API will return the following error response:

If the request is forbidden, the API will return the following error response:

Content typeapplication/jsonobject

messagestring
Forbidden resource

Example:Forbidden resource
errorstring
Forbidden

Example:Forbidden
statusCodeinteger
403

Example:403

404The customer does not exist or does not belong to your business.

The customer does not exist or does not belong to your business.

Content typeapplication/jsonobject

statusCodeintegerrequired
HTTP status code.
messagestringrequired
Explanation of the error.
errorstring
Name of the HTTP status, such as Bad Request or Conflict.
errorCodestring
Code that identifies the error. Present only on some errors.

500If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

Content typeapplication/jsonobject

statusCodeinteger
HTTP status code.

Example:500
messagestring
Explanation of the error.

Example:Internal Server Error