Users (Usuários)

Métodos para perfil, pedidos e eventos do usuário autenticado.

`getMe` 🔒

Busca o perfil completo do usuário autenticado.


const user = await sdk.users.getMe();

Retorno:

GetMeUserProps – dados completos do usuário logado.

Exemplo de resposta

Ver resposta


{
  "id": "cml5kizep000b0vr1uxdq1tte",
  "name": "John Doe",
  "email": "johndoe@meaple.com.br",
  "document": "11111111111",
  "phoneNumber": "+5511999999999",
  "birthdate": "2001-01-01T00:00:00.000Z",
  "role": "ADMIN",
  "avatar": {
    "url": "http://localhost:3333/a58de3cb-89b7-423e-bfbd-b95f45de2c5b.png"
  }
}

`getOrders` 🔒

Lista pedidos do usuário autenticado.


const orders = await sdk.users.getOrders({ status: 'PAID' });

Parâmetros (query):
- status?: 'PAID' | 'REFUNDED' | 'PENDING' – filtrar por status (e demais query params suportados pela API).

Retorno:

UserOrderProps[] – pedidos do usuário (cada item com id, status, totalPrice, totalFee, totalInsurance, createdAt, items).

Exemplo de resposta

Ver resposta


[
  {
    "id": "cmkzscyww0005ca0v3jz75058",
    "status": "PAID",
    "totalFee": 10,
    "totalPrice": 110,
    "totalInsurance": "0",
    "createdAt": "2026-01-29T18:26:47.361Z",
    "items": [
      {
        "id": "cmkzscyww0004ca0va3mt4cio",
        "amount": 1,
        "ticket": {
          "name": "Ticket Teste",
          "group": null,
          "event": {
            "name": "Event Test",
            "startsAt": "2026-01-29T21:21:00.000Z",
            "endsAt": "2026-01-29T22:21:00.000Z",
            "channel": {
              "id": "cmkzj64nx00030vbfd6yeoqk5",
              "name": "Atlética 18 de Setembro",
              "avatar": {
                "url": "http://localhost:3333/88d3b08d-618d-4487-81e4-b43a60974448.png",
                "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAABPElEQVR4nDXQMUgCYRgG4LcIrIRWb9ekpSFsjTYbnBpzioa21taGBlNnl8ZGNxcRQcHJRXARh5uUA+P0+D2FE/nv/nvju3B44eN7H374P5AfxwAwGr1l5/OXqusWB7+/+cF0mqr1eshKRyIxmM0apd2u4ZNfJMsxWYjJCyoFfzxGKUHD4fPlfv+9iuMf1mpFvV4/Rr5fiOr1lCbBzQarTgc5LJevFfKTSr1ry0rTtu9o21fMZCAvJng2QwWe99Any4yiJzOZ3DMMbxmGFicTMIpgBC4W6MPz8n2yQKVuDHlNYywac0IBSv1D103gWSUI0ux2z7XWpySPEqQ12O1CBwG4XKKCVgu5IMDKccBmE3o4RCSRWXbSiUl+PhqhtN3CNwa0bcQSmWUnXYIOx2y3kXUcVNdrDCQyy+5g/gACqvQIIsBspwAAAABJRU5ErkJggg=="
              }
            }
          }
        }
      }
    ]
  },
  {
    "id": "cml11rhsg0003re0v5dq83qa6",
    "status": "PAID",
    "totalFee": 20,
    "totalPrice": 220,
    "totalInsurance": "0",
    "createdAt": "2026-01-30T15:37:47.731Z",
    "items": [
      {
        "id": "cml11rhsf0001re0v4z39csy7",
        "amount": 1,
        "ticket": {
          "name": "Ingresso 01",
          "group": {
            "name": "Grupo 01"
          },
          "event": {
            "name": "Teste 02",
            "startsAt": "2026-01-30T15:36:00.000Z",
            "endsAt": "2027-01-30T16:36:00.000Z",
            "channel": {
              "id": "cmkzj64nx00030vbfd6yeoqk5",
              "name": "Atlética 18 de Setembro",
              "avatar": {
                "url": "http://localhost:3333/88d3b08d-618d-4487-81e4-b43a60974448.png",
                "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAABPElEQVR4nDXQMUgCYRgG4LcIrIRWb9ekpSFsjTYbnBpzioa21taGBlNnl8ZGNxcRQcHJRXARh5uUA+P0+D2FE/nv/nvju3B44eN7H374P5AfxwAwGr1l5/OXqusWB7+/+cF0mqr1eshKRyIxmM0apd2u4ZNfJMsxWYjJCyoFfzxGKUHD4fPlfv+9iuMf1mpFvV4/Rr5fiOr1lCbBzQarTgc5LJevFfKTSr1ry0rTtu9o21fMZCAvJng2QwWe99Any4yiJzOZ3DMMbxmGFicTMIpgBC4W6MPz8n2yQKVuDHlNYywac0IBSv1D103gWSUI0ux2z7XWpySPEqQ12O1CBwG4XKKCVgu5IMDKccBmE3o4RCSRWXbSiUl+PhqhtN3CNwa0bcQSmWUnXYIOx2y3kXUcVNdrDCQyy+5g/gACqvQIIsBspwAAAABJRU5ErkJggg=="
              }
            }
          }
        }
      },
      {
        "id": "cml11rhsf0002re0vcfqecapv",
        "amount": 1,
        "ticket": {
          "name": "Produto 01",
          "group": null,
          "event": {
            "name": "Teste 02",
            "startsAt": "2026-01-30T15:36:00.000Z",
            "endsAt": "2027-01-30T16:36:00.000Z",
            "channel": {
              "id": "cmkzj64nx00030vbfd6yeoqk5",
              "name": "Atlética 18 de Setembro",
              "avatar": {
                "url": "http://localhost:3333/88d3b08d-618d-4487-81e4-b43a60974448.png",
                "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAABPElEQVR4nDXQMUgCYRgG4LcIrIRWb9ekpSFsjTYbnBpzioa21taGBlNnl8ZGNxcRQcHJRXARh5uUA+P0+D2FE/nv/nvju3B44eN7H374P5AfxwAwGr1l5/OXqusWB7+/+cF0mqr1eshKRyIxmM0apd2u4ZNfJMsxWYjJCyoFfzxGKUHD4fPlfv+9iuMf1mpFvV4/Rr5fiOr1lCbBzQarTgc5LJevFfKTSr1ry0rTtu9o21fMZCAvJng2QwWe99Any4yiJzOZ3DMMbxmGFicTMIpgBC4W6MPz8n2yQKVuDHlNYywac0IBSv1D103gWSUI0ux2z7XWpySPEqQ12O1CBwG4XKKCVgu5IMDKccBmE3o4RCSRWXbSiUl+PhqhtN3CNwa0bcQSmWUnXYIOx2y3kXUcVNdrDCQyy+5g/gACqvQIIsBspwAAAABJRU5ErkJggg=="
              }
            }
          }
        }
      }
    ]
  },
  {
    "id": "cml1c9fb600090k0ve6pjc1nn",
    "status": "PAID",
    "totalFee": 30,
    "totalPrice": 280,
    "totalInsurance": "0",
    "createdAt": "2026-01-30T20:31:40.483Z",
    "items": [
      {
        "id": "cml1c9fb600060k0v2tw3a1rw",
        "amount": 1,
        "ticket": {
          "name": "Ingresso 01",
          "group": {
            "name": "Grupo 01"
          },
          "event": {
            "name": "Teste 02",
            "startsAt": "2026-01-30T15:36:00.000Z",
            "endsAt": "2027-01-30T16:36:00.000Z",
            "channel": {
              "id": "cmkzj64nx00030vbfd6yeoqk5",
              "name": "Atlética 18 de Setembro",
              "avatar": {
                "url": "http://localhost:3333/88d3b08d-618d-4487-81e4-b43a60974448.png",
                "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAABPElEQVR4nDXQMUgCYRgG4LcIrIRWb9ekpSFsjTYbnBpzioa21taGBlNnl8ZGNxcRQcHJRXARh5uUA+P0+D2FE/nv/nvju3B44eN7H374P5AfxwAwGr1l5/OXqusWB7+/+cF0mqr1eshKRyIxmM0apd2u4ZNfJMsxWYjJCyoFfzxGKUHD4fPlfv+9iuMf1mpFvV4/Rr5fiOr1lCbBzQarTgc5LJevFfKTSr1ry0rTtu9o21fMZCAvJng2QwWe99Any4yiJzOZ3DMMbxmGFicTMIpgBC4W6MPz8n2yQKVuDHlNYywac0IBSv1D103gWSUI0ux2z7XWpySPEqQ12O1CBwG4XKKCVgu5IMDKccBmE3o4RCSRWXbSiUl+PhqhtN3CNwa0bcQSmWUnXYIOx2y3kXUcVNdrDCQyy+5g/gACqvQIIsBspwAAAABJRU5ErkJggg=="
              }
            }
          }
        }
      },
      {
        "id": "cml1c9fb600070k0vgnvhf6tz",
        "amount": 1,
        "ticket": {
          "name": "Produto 01",
          "group": null,
          "event": {
            "name": "Teste 02",
            "startsAt": "2026-01-30T15:36:00.000Z",
            "endsAt": "2027-01-30T16:36:00.000Z",
            "channel": {
              "id": "cmkzj64nx00030vbfd6yeoqk5",
              "name": "Atlética 18 de Setembro",
              "avatar": {
                "url": "http://localhost:3333/88d3b08d-618d-4487-81e4-b43a60974448.png",
                "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAABPElEQVR4nDXQMUgCYRgG4LcIrIRWb9ekpSFsjTYbnBpzioa21taGBlNnl8ZGNxcRQcHJRXARh5uUA+P0+D2FE/nv/nvju3B44eN7H374P5AfxwAwGr1l5/OXqusWB7+/+cF0mqr1eshKRyIxmM0apd2u4ZNfJMsxWYjJCyoFfzxGKUHD4fPlfv+9iuMf1mpFvV4/Rr5fiOr1lCbBzQarTgc5LJevFfKTSr1ry0rTtu9o21fMZCAvJng2QwWe99Any4yiJzOZ3DMMbxmGFicTMIpgBC4W6MPz8n2yQKVuDHlNYywac0IBSv1D103gWSUI0ux2z7XWpySPEqQ12O1CBwG4XKKCVgu5IMDKccBmE3o4RCSRWXbSiUl+PhqhtN3CNwa0bcQSmWUnXYIOx2y3kXUcVNdrDCQyy+5g/gACqvQIIsBspwAAAABJRU5ErkJggg=="
              }
            }
          }
        }
      },
      {
        "id": "cml1c9fb600080k0v6qjacet6",
        "amount": 1,
        "ticket": {
          "name": "Produto 02",
          "group": null,
          "event": {
            "name": "Teste 02",
            "startsAt": "2026-01-30T15:36:00.000Z",
            "endsAt": "2027-01-30T16:36:00.000Z",
            "channel": {
              "id": "cmkzj64nx00030vbfd6yeoqk5",
              "name": "Atlética 18 de Setembro",
              "avatar": {
                "url": "http://localhost:3333/88d3b08d-618d-4487-81e4-b43a60974448.png",
                "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAABPElEQVR4nDXQMUgCYRgG4LcIrIRWb9ekpSFsjTYbnBpzioa21taGBlNnl8ZGNxcRQcHJRXARh5uUA+P0+D2FE/nv/nvju3B44eN7H374P5AfxwAwGr1l5/OXqusWB7+/+cF0mqr1eshKRyIxmM0apd2u4ZNfJMsxWYjJCyoFfzxGKUHD4fPlfv+9iuMf1mpFvV4/Rr5fiOr1lCbBzQarTgc5LJevFfKTSr1ry0rTtu9o21fMZCAvJng2QwWe99Any4yiJzOZ3DMMbxmGFicTMIpgBC4W6MPz8n2yQKVuDHlNYywac0IBSv1D103gWSUI0ux2z7XWpySPEqQ12O1CBwG4XKKCVgu5IMDKccBmE3o4RCSRWXbSiUl+PhqhtN3CNwa0bcQSmWUnXYIOx2y3kXUcVNdrDCQyy+5g/gACqvQIIsBspwAAAABJRU5ErkJggg=="
              }
            }
          }
        }
      }
    ]
  },
  {
    "id": "cml5cl3b8000bju0v7egha3ys",
    "status": "PAID",
    "totalFee": 20,
    "totalPrice": 228,
    "totalInsurance": "8",
    "createdAt": "2026-02-02T15:51:49.510Z",
    "items": [
      {
        "id": "cml5cl3b70009ju0v4jzsbvhe",
        "amount": 1,
        "ticket": {
          "name": "Ingresso 01",
          "group": {
            "name": "Grupo 01"
          },
          "event": {
            "name": "Teste 02",
            "startsAt": "2026-01-30T15:36:00.000Z",
            "endsAt": "2027-01-30T16:36:00.000Z",
            "channel": {
              "id": "cmkzj64nx00030vbfd6yeoqk5",
              "name": "Atlética 18 de Setembro",
              "avatar": {
                "url": "http://localhost:3333/88d3b08d-618d-4487-81e4-b43a60974448.png",
                "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAABPElEQVR4nDXQMUgCYRgG4LcIrIRWb9ekpSFsjTYbnBpzioa21taGBlNnl8ZGNxcRQcHJRXARh5uUA+P0+D2FE/nv/nvju3B44eN7H374P5AfxwAwGr1l5/OXqusWB7+/+cF0mqr1eshKRyIxmM0apd2u4ZNfJMsxWYjJCyoFfzxGKUHD4fPlfv+9iuMf1mpFvV4/Rr5fiOr1lCbBzQarTgc5LJevFfKTSr1ry0rTtu9o21fMZCAvJng2QwWe99Any4yiJzOZ3DMMbxmGFicTMIpgBC4W6MPz8n2yQKVuDHlNYywac0IBSv1D103gWSUI0ux2z7XWpySPEqQ12O1CBwG4XKKCVgu5IMDKccBmE3o4RCSRWXbSiUl+PhqhtN3CNwa0bcQSmWUnXYIOx2y3kXUcVNdrDCQyy+5g/gACqvQIIsBspwAAAABJRU5ErkJggg=="
              }
            }
          }
        }
      },
      {
        "id": "cml5cl3b8000aju0v2m4u2jnd",
        "amount": 1,
        "ticket": {
          "name": "Produto 02",
          "group": null,
          "event": {
            "name": "Teste 02",
            "startsAt": "2026-01-30T15:36:00.000Z",
            "endsAt": "2027-01-30T16:36:00.000Z",
            "channel": {
              "id": "cmkzj64nx00030vbfd6yeoqk5",
              "name": "Atlética 18 de Setembro",
              "avatar": {
                "url": "http://localhost:3333/88d3b08d-618d-4487-81e4-b43a60974448.png",
                "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAABPElEQVR4nDXQMUgCYRgG4LcIrIRWb9ekpSFsjTYbnBpzioa21taGBlNnl8ZGNxcRQcHJRXARh5uUA+P0+D2FE/nv/nvju3B44eN7H374P5AfxwAwGr1l5/OXqusWB7+/+cF0mqr1eshKRyIxmM0apd2u4ZNfJMsxWYjJCyoFfzxGKUHD4fPlfv+9iuMf1mpFvV4/Rr5fiOr1lCbBzQarTgc5LJevFfKTSr1ry0rTtu9o21fMZCAvJng2QwWe99Any4yiJzOZ3DMMbxmGFicTMIpgBC4W6MPz8n2yQKVuDHlNYywac0IBSv1D103gWSUI0ux2z7XWpySPEqQ12O1CBwG4XKKCVgu5IMDKccBmE3o4RCSRWXbSiUl+PhqhtN3CNwa0bcQSmWUnXYIOx2y3kXUcVNdrDCQyy+5g/gACqvQIIsBspwAAAABJRU5ErkJggg=="
              }
            }
          }
        }
      }
    ]
  }
]

`getEvents` 🔒

Lista eventos do usuário (para os quais ele tem ingressos).


const events = await sdk.users.getEvents();

Retorno:

GetUserEventsProps[] – eventos do usuário.

Exemplo de resposta

Ver resposta


[
  {
    "id": "cml0vazf400000vo1rfy5g3pt",
    "slug": "teste-02",
    "name": "Teste 02",
    "description": [],
    "canceledAt": null,
    "endsAt": "2027-01-30T16:36:00.000Z",
    "startsAt": "2026-01-30T15:36:00.000Z",
    "opensAt": null,
    "timezone": "America/Sao_Paulo",
    "status": "PUBLISHED",
    "channel": {
      "id": "cmkzj64nx00030vbfd6yeoqk5",
      "name": "Atlética 18 de Setembro",
      "slug": "atletica-18-de-setembro",
      "avatar": {
        "url": "http://localhost:3333/88d3b08d-618d-4487-81e4-b43a60974448.png",
        "base64": "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAABPElEQVR4nDXQMUgCYRgG4LcIrIRWb9ekpSFsjTYbnBpzioa21taGBlNnl8ZGNxcRQcHJRXARh5uUA+P0+D2FE/nv/nvju3B44eN7H374P5AfxwAwGr1l5/OXqusWB7+/+cF0mqr1eshKRyIxmM0apd2u4ZNfJMsxWYjJCyoFfzxGKUHD4fPlfv+9iuMf1mpFvV4/Rr5fiOr1lCbBzQarTgc5LJevFfKTSr1ry0rTtu9o21fMZCAvJng2QwWe99Any4yiJzOZ3DMMbxmGFicTMIpgBC4W6MPz8n2yQKVuDHlNYywac0IBSv1D103gWSUI0ux2z7XWpySPEqQ12O1CBwG4XKKCVgu5IMDKccBmE3o4RCSRWXbSiUl+PhqhtN3CNwa0bcQSmWUnXYIOx2y3kXUcVNdrDCQyy+5g/gACqvQIIsBspwAAAABJRU5ErkJggg=="
      }
    },
    "image": {
      "url": "http://localhost:3333/8c2d30d1-2ce7-43e0-b2d3-4bef4839eddf.png",
      "base64": "iVBORw0KGgoAAAANSUhEUgAAAAMAAAAKCAIAAAD+RXMgAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAWklEQVR4nB3KMQ6FERBF4btdC7KVWYKoVSSKIUHsQHGNl/+d9jsgWWslib13zvneC1Vda5kZ5pyqes5B77219mkpJcY4xoCIOOdEBCEE731KCWZG8vvee/bvB5RjTu5miUY/AAAAAElFTkSuQmCC"
    },
    "address": {
      "city": "Curitiba",
      "country": "Brasil",
      "number": "1100",
      "neighborhood": null,
      "state": "Paraná",
      "street": "Rua Mauá",
      "zipCode": "80030-200",
      "latitude": -25.4161704,
      "longitude": -49.2644989
    }
  }
]

`refundOrder` 🔒

Solicita reembolso de um pedido.


await sdk.users.refundOrder(orderId);

Parâmetros:
- orderId: string – ID do pedido.

Retorno:

string – resposta vazia em caso de sucesso.

Exemplo de resposta

Ver resposta

""

Users (Usuários)

getMe 🔒

Ver resposta

getOrders 🔒

Ver resposta

getEvents 🔒

Ver resposta

refundOrder 🔒

Ver resposta

`getMe` 🔒

`getOrders` 🔒

`getEvents` 🔒

`refundOrder` 🔒