Skip to main content
GET
/
api
/
v1
/
products
Listar produtos
curl --request GET \
  --url https://besimplo.com/api/v1/products \
  --header 'Authorization: <api-key>'
{
  "object": "list",
  "url": "/api/v1/products",
  "has_more": false,
  "data": [
    {
      "id": "prod_01h455vb4pex5vsknk084sn02q",
      "object": "product",
      "active": true,
      "created": 1680893993,
      "live_mode": false,
      "name": "Plano Premium",
      "description": "Acesso a todas as funcionalidades premium",
      "external_code": "prod_premium"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

A chave de API usada para autenticar a requisição e identificar a sua conta.

Exemplo: Authorization: ApiKey my-secure-key

Query Parameters

​
active
boolean

Filtrar por status ativo/inativo

​
limit
integer
default:20

Resultados por página

Required range: 1 <= x <= 100
​
page
string

Cursor para próxima página

Response

Lista de produtos

​
object
enum<string>
required

Tipo do objeto. Sempre 'list'.

Available options:
list
Example:

"list"

​
url
string<uri-reference>
required

URL do recurso solicitado.

Example:

"/api/v1/products"

​
has_more
boolean
required

Indica se há mais resultados disponíveis para paginação.

Example:

false

​
data
object[]
required

Lista de produtos.