---
title: Listar clientes
slug: listar-clientes
createdAt: 2022-07-01T18:06:35.000Z
---

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "https://sandbox.partner.graphql.gyramais.com.br/",
  "name": "Listar clientes",
  "method": "POST",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [
      {
        "kind": "optional",
        "name": "limit",
        "type": "Integer",
        "description": "Número máximo de retorno por requisição(página) (Padrão/máximo = 100)"
      },
      {
        "kind": "optional",
        "name": "offset",
        "type": "Integer",
        "description": "Quantidade de pulos de requisições(páginas) baseado no limit"
      }
    ],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "L7NM10JdWihDGeVdXQmuJ",
        "code": "{\n    \"customers\": [\n      {\n        \"id\": \"747U1hzj4y\",\n        \"name\": \"AD\",\n        \"legalName\": \"ASDADS\",\n        \"cnpj\": \"81469153000184\",\n        \"user\": {\n          \"id\":\"00mock0user0id\"\n          \"email\":\"emailexample@email.com\"\n        },\n        \"platformType\": {\n          \"id\": \"zKoHMMhddq\",\n          \"name\": \"Vendas loja física\",\n          \"value\": \"1\"\n        },\n        \"sector\": {\n          \"id\": \"DPZey4Sdve\",\n          \"name\": \"Eletroeletrônicos\",\n          \"value\": \"6\"\n        },\n        \"segment\": {\n          \"id\": \"9Et8Rr3kbU\",\n          \"name\": \"Serviços\",\n          \"value\": \"2\"\n        },\n        \"employeesNumber\": 0,\n        \"revenueAmount\": 150000\n      },\n      {\n        \"id\": \"Bjbzoc1UmA\",\n        \"name\": \"RTEHGF\",\n        \"legalName\": \"FGGFHFG\",\n        \"cnpj\": \"23885394000108\",\n          \"user\": {\n          \"id\":\"11mock0user0id\"\n          \"email\":\"emailexample@email.com\"\n        },\n        \"platformType\": {\n          \"id\": \"zKoHMMhddq\",\n          \"name\": \"Vendas loja física\",\n          \"value\": \"1\"\n        },\n        \"sector\": {\n          \"id\": \"DPZey4Sdve\",\n          \"name\": \"Eletroeletrônicos\",\n          \"value\": \"6\"\n        },\n        \"segment\": {\n          \"id\": \"9Et8Rr3kbU\",\n          \"name\": \"Serviços\",\n          \"value\": \"2\"\n        },\n        \"employeesNumber\": 0,\n        \"revenueAmount\": 150000\n      }\n    ]\n  }\n}",
        "language": "200",
        "customLabel": ""
      },
      {
        "id": "F1hg_0v74a_PpfDQdDUKc",
        "code": "{\n  \"message\": \"Ain't no cake like that.\"\n}",
        "language": "404",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "L7NM10JdWihDGeVdXQmuJ"
  },
  "examples": {
    "languages": [
      {
        "id": "hzh0VWmyifFVea9Yw3mQi",
        "code": "headers\r\n{\r\n  \"Authorization\": \"\"\r\n}\r\nquery customers{\r\n  customers(\r\n    limit: 100\r\n    offset: 0\r\n  ){\r\n    id\r\n    name\r\n    legalName\r\n    cnpj\r\n    user{\r\n      id\r\n      email\r\n    }\r\n    platformType{\r\n      id\r\n      name\r\n      value\r\n    }\r\n    sector{\r\n      id\r\n      name\r\n      value\r\n    }\r\n    segment{\r\n      id\r\n      name\r\n      value\r\n    }\r\n    employeesNumber\r\n    revenueAmount\r\n  }\r\n}",
        "language": "graphql",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "hzh0VWmyifFVea9Yw3mQi"
  },
  "description": "Método que retorna uma lista de clientes.",
  "currentNewParameter": {
    "label": "Query Parameter",
    "value": "queryParameters"
  }
}
```
:::