v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Buscar Cliente

Retorna os dados de um cliente

get/customers/{id}

Path parameters

idstring required

ID do cliente

Response

200

idstring

emailstring

namestring

notesstring

created_atstring

updated_atstring

{"stackTrail":"paths:/customers/{id}:get:responses:200:content:application/json:schema:properties:cc_emails","oasType":"schema","type":"unknown"}

cpf_cnpjstring

zip_codestring

numberstring

complementstring

phonestring

phone_prefixstring

payment_methodsobject[]

{"stackTrail":"paths:/customers/{id}:get:responses:200:content:application/json:schema:properties:default_payment_method_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/customers/{id}:get:responses:200:content:application/json:schema:properties:proxy_payments_from_customer_id","oasType":"schema","type":"unknown"}

citystring

statestring

districtstring

streetstring

Example response

{
  "id": "6A7BE09792BA40CFB13AA504367E5E12",
  "email": "email@iugu.com",
  "name": "Nome do Cliente",
  "notes": "Nota  sobre este cliente",
  "created_at": "2025-04-03T12:04:38-03:00",
  "updated_at": "2025-04-03T12:07:31-03:00",
  "cpf_cnpj": "11343675030",
  "zip_code": "13056-344",
  "number": "60",
  "complement": "APTO 1702",
  "phone": "972312345",
  "phone_prefix": "11",
  "custom_variables": [
    {
      "name": "My-var",
      "value": "var"
    }
  ],
  "city": "Campinas",
  "state": "SP",
  "district": "Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)",
  "street": "Rua Antônio Nunes"
}