Skip to main content
GET
/
api
/
management
/
customers
Listar clientes
curl --request GET \
  --url https://api.olie.ai/api/management/customers \
  --header 'Authorization: Bearer <token>'
{
  "response": true,
  "customers": [
    {
      "id": "9d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a",
      "name": "Cliente Exemplo LTDA",
      "headquarter": "Cliente Exemplo LTDA",
      "branch": null,
      "company_name": "Cliente Exemplo Comércio LTDA",
      "document_type": 2,
      "customer_type": 1,
      "document": "12.345.678/0001-90",
      "main_activity": "Comércio de produtos alimentícios",
      "email": "[email protected]",
      "phone": "(11) 98765-4321",
      "address": "Rua Exemplo, 123 - Centro - São Paulo/SP",
      "description": "Cliente do segmento de alimentação",
      "custom_fields": null,
      "status": true,
      "form_answers": [],
      "parent_id": null,
      "frame_id": "8c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f",
      "created_at": "2026-01-15T10:30:00.000000Z",
      "updated_at": "2026-01-15T10:30:00.000000Z",
      "deleted_at": null,
      "created_by": 123,
      "contacts_count": 2,
      "projects_count": 5
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "per_page": 15,
    "to": 15,
    "total": 150
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Sucesso

response
enum<boolean>
required

Indicador de sucesso da requisição

Available options:
true
customers
object[]
required

Array com os objetos de clientes

meta
object
required

Metadados da paginação