Saltar a contenido

Lista de Empresas

Definición

GET https://api.avanto.mx/v1/companies

Recursos

Recurso Tipo Default Descripción
q string none Consulta. Texto a buscar en company_name (nombre fiscal) o en sic_code (RFC)
fields string none Campo o lista de campos a obtener
expand string none Objeto u objetos relacionados a obtener: fiscalRegimes y/o companySubsidiaries
page integer 1 Página de resultados a regresar
limit string 20 Número del 1 al 20 que representa la cantidad máxima de resultados a regresar por paginación

Ejemplos

Vía HTTPS:

Obtener las empresas que su Nombre de empresa o RFC contiene "LAN"

GET https://api.avanto.mx/v1/companies?q=LAN

Obtener las siguientes 10 empresas a partir de la página 2

GET https://api.avanto.mx/v1/companies?page=2&limit=10

Obtener los campos de Nombre de empresa, RFC y Regímenes

GET https://api.avanto.mx/v1/companies?fields=company_name,sic_code,fiscalRegimes.regime&expand=fiscalRegimes

VÍA cURL:

Obtener las empresas que su Nombre de empresa o RFC contiene "LAN"

curl --request GET \
  --url 'https://api.avanto.mx/v1/companies?q=LAN' \
  --header 'authorization: Bearer [token de autenticación sin corchetes]'

Obtener las siguientes 10 empresas a partir de la página 2

curl --request GET \
  --url 'https://api.avanto.mx/v1/companies?page=2&limit=10' \
  --header 'authorization: Bearer [token de autenticación sin corchetes]'

Obtener los campos de Nombre de empresa, RFC y Regímenes

curl --request GET \
  --url 'https://api.avanto.mx/v1/companies?fields=company_name%2Csic_code%2CfiscalRegimes.regime&expand=fiscalRegimes' \
  --header 'authorization: Bearer [token de autenticación sin corchetes]'