GET
/
v1
/
products
/
eligibles

Authorizations

Authorization
string
headerrequired

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

Query Parameters

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.

fields
string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

document
string

Um filtro com base no campo document. O valor deve ser uma string ou uma lista separada por vírgula

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.

status
enum<string>

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

Available options:
active,
inactive
grossSalary
number

Um parâmetro para substituir o campo grossSalary do employment. O valor deve ser um número

netSalary
number

Um parâmetro para substituir o campo netSalary do employment. O valor deve ser um número

limitPerInstallment
number

Um parâmetro para substituir o campo limitPerInstallment do employment. O valor deve ser um número

limitPerLoan
number

Um parâmetro para substituir o campo limitPerLoan do employment. O valor deve ser um número

hiredAt
string

Um parâmetro para substituir o campo hiredAt do employment. O valor deve ser uma string

loansToIgnore
string

Pode ser um valor único ou uma lista separada por vírgula para excluir empréstimos da verificação de produtos elegíveis.

Response

200 - application/json
hasMore
boolean

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

data
object[]

Uma lista de produtos