Listar empresas
GET
/api/public/v1/companiesDevuelve una página de empresas. Admite filtros por texto libre (text), taxIdentificationValue, branchCode y lastModifiedDateFrom, además de paginado. La respuesta usa el formato HAL.
Autorización
apiKeyScheme X-API-KEY<token>
En: header
Parámetros de consulta
page?integer
Número de página a devolver, comenzando en 0.
Formato
int32size?integer
Cantidad de elementos por página.
Formato
int32sort?array<>
Criterios de ordenamiento del resultado.
Criterios de ordenamiento, enviados como sort[0].property y sort[0].direction (ASC o DESC). Sin ordenamiento explícito, el orden de los resultados no está garantizado.
property?string
direction?string
Valor en
- "ASC"
- "DESC"
text?string
Texto libre para buscar empresas por nombre u otros campos de texto.
taxIdentificationValue?string
Filtra por el valor exacto de la identificación fiscal de la empresa.
include?array<string>
Lista de uniqueCode de empresas: si se informa, sólo se devuelven esas empresas (combinado con el resto de los filtros).
branchCode?string
Filtra por el código de sucursal de la empresa.
lastModifiedDateFrom?string
Filtra empresas modificadas desde esta fecha (inclusive).
Formato
date-timeCuerpo de la respuesta
application/vnd.hal+json
application/json
application/json
curl -X GET "https://example.com/api/public/v1/companies?lastModifiedDateFrom=2024-11-13T16%3A51%3A00.000Z"{ "_embedded": { "companies": [ { "_links": { "property1": { "href": "string", "hreflang": "string", "title": "string", "type": "string", "deprecation": "string", "profile": "string", "name": "string", "templated": true }, "property2": { "href": "string", "hreflang": "string", "title": "string", "type": "string", "deprecation": "string", "profile": "string", "name": "string", "templated": true } }, "deleted": true, "uniqueCode": "0590843e-1d92-4d51-82c6-4a22a6b8be82", "companyCode": "string", "lastModifiedDate": "2024-11-13T16:51:00.000Z", "createdDate": "2024-11-13T16:51:00.000Z", "createdBy": "string", "externalId": "string", "phoneNumber": "string", "currency": { "code": "string", "minDecimalPlaces": 0, "maxDecimalPlaces": 0 }, "address": { "countryCode": "ABW", "state": "string", "city": "string", "zipCode": "string", "municipality": "string", "neighborhood": "string", "neighborhoodSat": "string", "neighborhoodSepomex": "string", "street": "string", "line1": "string", "number": "string", "interiorNumber": "string", "floor": "string", "department": "string", "fullAddress": "string" }, "locale": "string", "countryCode": "MX", "timezone": "string", "logoURL": "string", "accountTypeEnabled": true, "management": { "salesManager": "string", "businessUserPrincipal": "string", "decisionMaker": "string", "billingEmail": "ana.lopez@empresa.com", "registeredNamesQuantity": 0, "virtualCardQuantity": 0, "physicalCardsQuantity": 0 }, "risk": { "economicGroup": "string" }, "billingType": "FULL", "legalInformation": { "name": "string", "legalName": "string", "fantasyName": "string", "taxIdentificationType": "RFC", "taxIdentificationValue": "string", "branchCode": "string", "satEconomicActivity": "string", "signingContractDate": "2019-08-24", "approvedCreditLine": 0, "regimenFiscal": "string", "denominacionSocial": "string", "corporateName": "string", "corporateName2": "string", "sharePercentage": 0, "sharePercentage2": 0, "ownerName": "string", "ownerTaxIdentificationType": "CUIL", "ownerTaxIdentificationValue": "string", "ownerBirthCountry": "ABW", "ownerNationality": "string", "ownerGender": "MALE", "ownerEmail": "ana.lopez@empresa.com", "ownerPhoneNumber": "string", "curp": "string", "ownerOccupation": "string", "ownerStreet": "string", "ownerSuburb": "string", "ownerMunicipality": "string", "ownerCity": "string", "ownerState": "string", "ownerZipCode": "string", "ownerPoliticallyExposed": true, "solicitedCardsQty": 0, "givenCardsQty": 0, "operationType": "string", "monetaryInstrument": "string", "cnbv": "string", "risk": "HIGH", "csfFileName": "string", "csfFileUniqueCode": "string", "csfDate": "2019-08-24" }, "creditLine": { "deleted": true, "uniqueCode": "0590843e-1d92-4d51-82c6-4a22a6b8be82", "companyCode": "string", "lastModifiedDate": "2024-11-13T16:51:00.000Z", "createdDate": "2024-11-13T16:51:00.000Z", "createdBy": "string", "externalId": "string", "enabled": true, "monthlyLimit": 50000, "available": 32000, "consumed": 18000, "billingCycleUniqueCode": "string", "setupFee": 500, "monthlyFee": 150, "implementationAdditionalFee": 1000, "nonPaymentFee": 200, "billingCycleCode": "string", "withdrawalFee": 75, "unusedCardFee": 50, "feeCurrencyCode": "MXN", "initialLineRequested": 100000, "initialLineCredit": 80000, "lineApprovalDate": "2024-11-13T16:51:00.000Z" } } ] }, "_links": { "property1": { "href": "string", "hreflang": "string", "title": "string", "type": "string", "deprecation": "string", "profile": "string", "name": "string", "templated": true }, "property2": { "href": "string", "hreflang": "string", "title": "string", "type": "string", "deprecation": "string", "profile": "string", "name": "string", "templated": true } }, "page": { "size": 0, "totalElements": 0, "totalPages": 0, "number": 0 }}