v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
merchants

Retorna uma lista de empresas.

get/v1/merchants

Query parameters

pageinteger

Page of results to fetch.

per_pageinteger

Number of results to return per page.

querystring

Filtro para busca

sort_by'id' | 'name' | 'status' | 'code' | 'email' | 'registry_code' | 'created_at' | 'updated_at'

Atributo opcional para ordenação

sort_order'asc' | 'desc'

Sentido opcional para ordenação

Response

Consulta realizada com sucesso.

idinteger required

ID da empresa

namestring required

Nome da empresa

company_namestring required

Razão social

registry_codestring required

CNPJ da empresa

emailstring required

Email de contato da empresa

status'active' | 'inactive' | 'trial' required

Status da empresa