GET
/
v1
/
products
curl --request GET \
  --url https://api.base39.io/v1/products \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "id": "prod_5f92f01728e009f403d8502e",
      "slug": "consignado",
      "status": "active",
      "name": "Empréstimo consignado",
      "description": "<string>",
      "settings": {
        "steps": {
          "title": "<string>",
          "type": "signature",
          "methodData": {
            "schema": {
              "type": "operator",
              "role": "approver"
            }
          },
          "needs": [
            "<string>"
          ],
          "slug": "<string>",
          "hooks": {
            "onFailure": [
              "void_loan"
            ]
          },
          "onStart": [
            "mark_loan_as_pending"
          ]
        },
        "loans": {
          "concurrency": [
            {
              "quantityAllowed": 123,
              "status": [
                "open"
              ]
            }
          ],
          "conditions": [
            {
              "title": "<string>",
              "content": "<string>"
            }
          ],
          "maxAge": 65,
          "minAge": 18,
          "minimumWage": 2500
        },
        "invoices": {
          "payOff": {
            "fine": {
              "amount": 0.02,
              "daysToStart": 1
            },
            "interest": {
              "amount": 0.01,
              "daysToStart": 1
            },
            "allowOverduePayment": true,
            "daysUntilDue": {
              "type": "absolute",
              "amount": 1
            },
            "updateInvoiceItemOnInsert": true
          }
        },
        "products": {
          "eligibility": {
            "type": "static",
            "options": {
              "url": "<string>",
              "headers": {},
              "metadata": {}
            }
          },
          "offer": {
            "type": "online",
            "options": {
              "monthlyFee": 1.99,
              "numberOfInstallments": [
                12,
                24
              ],
              "daysUntilDisbursement": 7,
              "monthsUntilFirstDueDate": 1,
              "creditOperationType": "CCB",
              "rebates": [
                {
                  "feeType": "registration",
                  "amountType": "absolute",
                  "amount": 250,
                  "description": "Tarifa de cadastro"
                }
              ],
              "insurance": {
                "amount": 0,
                "fee": 1.73,
                "type": "required",
                "number": "123456",
                "insurer": "Cia de Seguros"
              }
            }
          },
          "documents": {
            "toCreate": [
              {
                "purpose": "account_requirement",
                "method": "google",
                "methodData": {
                  "template": "<string>"
                }
              }
            ],
            "toRequest": [
              {
                "purpose": "account_requirement",
                "name": "crédito consignado",
                "owner": "customer",
                "expireInDays": 30
              }
            ]
          },
          "disbursement": "custom"
        }
      },
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
exclude_fields
string

Campos a remover do corpo da resposta. O valor deve ser uma string ou uma lista separada por vírgula. Campos informados que não existem na resposta serão descartados.

​
expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

​
starting_after
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

​
ending_before
string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

​
limit
integer
default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

​
fields
string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

​
status
enum<string>

O status do produto. O valor deve ser uma string.

Available options:
active,
inactive
Example:

"active"

​
type
enum<string>

O tipo do produto. O valor deve ser uma string.

Available options:
online,
offline,
mock

Response

200 - application/json
Um objeto com uma propriedade `data` que contém um array de itens começando após o item `starting_after`. Cada entrada no array é um objeto `Product` separado. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de produtos.

​
hasMore
boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

​
data
object[]

Uma lista de produtos

Este objeto representa um produto.