Skip to main content
GET
/
organizations
/
{organizationId}
/
vouchers
Listar Vouchers
curl --request GET \
  --url https://api.example.com/organizations/{organizationId}/vouchers \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "externalRef": "vo_stripe_abc",
      "name": "Welcome Credit",
      "amount": 10000,
      "currency": "BRL",
      "effectiveAt": "2026-01-01T00:00:00.000Z",
      "expiresAt": "2026-12-31T23:59:59.000Z",
      "amountRedeemed": 2500,
      "status": "ACTIVE",
      "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "totalItems": 2,
    "totalPages": 1
  }
}
Retorna uma lista de vouchers. 
curl "https://api.awsales.io/studio/organizations/ORG_ID/vouchers?page=1&limit=20" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Requer permissao voucher:read.

​
Cabecalhos

​
Authorization
string
required
Token bearer.

​
Parametros de Rota

​
organizationId
string
required
O UUID da organizacao.

​
Parametros de Consulta

​
page
integer
Numero da pagina.
​
limit
integer
Resultados por pagina.
​
status
string
Filtrar por status.
​
sort
string
Campo e direcao de ordenacao.

​
Resposta

​
data
array
Array de objetos de voucher.
​
meta
object
Metadados de paginacao.
{
  "data": [
    {
      "voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "externalRef": "vo_stripe_abc",
      "name": "Welcome Credit",
      "amount": 10000,
      "currency": "BRL",
      "effectiveAt": "2026-01-01T00:00:00.000Z",
      "expiresAt": "2026-12-31T23:59:59.000Z",
      "amountRedeemed": 2500,
      "status": "ACTIVE",
      "createdBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "totalItems": 2,
    "totalPages": 1
  }
}
Valores estao em centavos (ex.: 10000 = R$100,00).

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404organization.not_foundOrganizacao nao encontrada
500internal_server_errorOcorreu um erro inesperado