Lista de Empresas¶
Definición¶
GET https://api.avanto.mx/v2/companies
Parámetros¶
| Parámetro | Tipo | Default | Descripción |
|---|---|---|---|
| q | string | Consulta. Texto a buscar en company_name (nombre fiscal) o en sic_code (RFC) | |
| fields | string | Campo o lista de campos a obtener | |
| expand | string | 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 cURL¶
Obtener las empresas que su Nombre de empresa o RFC contiene "LAN":
curl --request GET \
--url 'https://api.avanto.mx/v2/companies?q=LAN' \
--header 'authorization: Bearer [Access-Token]'
Obtener las siguientes 10 empresas a partir de la página 2:
curl --request GET \
--url 'https://api.avanto.mx/v2/companies?page=2&limit=10' \
--header 'authorization: Bearer [Access-Token]'
Obtener los campos de Nombre de empresa, RFC y Regímenes:
curl --request GET \
--url 'https://api.avanto.mx/v2/companies?fields=company_name%2Csic_code%2CfiscalRegimes.regime&expand=fiscalRegimes' \
--header 'authorization: Bearer [Access-Token]'
Ejemplo de Respuesta¶
La respuesta en formato: application/json, text/json.
[
{
"id": 1,
"company_name": "ESCUELA KEMPER URGATE",
"sic_code": "EKU9003173C9",
"created_at": "2017-05-30 13:28:28"
},
{
"id": 14,
"company_name": "BERENICE XIMO QUEZADA",
"sic_code": "XIQB891116QE4",
"created_at": "2019-03-28 19:10:46"
}
]