Buscar Compañías

GET/companies/v1/

El endpoint /companies/v1/ te permite buscar un grupo de compañías y recibir una lista ordenada en base a los parámetros especificados.

Consideraciones

Podrás especificar tus filtros como parámetros siguiendo este patrón: filter[campo]=valor. Por ejemplo: /companies/v1/?filter[status]=ACTIVE Para filtrar un atributo con varios valores posibles, deberás separar los valores con comas. Por ejemplo: filter[status]=ACTIVE,BLOCKED

Los resultados serán paginados y podrás especificar la cantidad de datos por página y también qué página ver utilizando: page[number]=valor y page[size]=valor

Ordenamiento

Podrás especificar el orden de los resultados con determinados parámetros que deberás enviar como una lista de strings en el filtro de tipo sort\. Por ejemplo: ?filter[status]=ACTIVE&sort=status

El ordenamiento por defecto será ascendente. Para especificar un orden descendente, deberás enviar el carácter "-" como prefijo del atributo. Por ejemplo: /companies/v1/?filter[status]=ACTIVE&sort=status,-tax_identification_type

Los posibles atributos para ordenar son:

id
legal_name
trade_name
tax_identification_type
tax_identification_value
status

Parámetros disponibles

Header Parameters

AuthorizationStringrequired

Query Parameters

filter[tax_identification_type]enum

filter[tax_identification_value]String

filter[legal_name]String

filter[trade_name]String

filter[email]String

filter[status]String

filter[country_code]String

filter[type]enum

page[size]Number

page[number]Number

sortString

Detalle de respuestas

401

No autorizado

403

Acceso denegado

Ejemplo de código

curl -X GET "https://api.pomelo.la/companies/v1/?filter[tax_identification_type]=CUIL&filter[tax_identification_value]=example_value&filter[legal_name]=Pomelo SAS&filter[trade_name]=Pomelo&filter[email][email protected]&filter[status]=ACTIVE&filter[country_code]=ARG&filter[type]=MEI&page[size]=123&page[number]=123&sort=id,-legal_name" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Ejemplo de respuesta (200)Resultados de la búsqueda

{
  "data": [
    {
      "id": "cmp-2E5eUyw1ZolEj1Y3NHxnob7bFZe",
      "legal_name": "Pomelo SAS",
      "trade_name": "Pomelo",
      "tax_identification_type": "CNPJ",
      "tax_identification_value": "43.856.175/0001-08",
      "email": "[email protected]",
      "phone": "1123456789",
      "operation_country": "ARG",
      "type": "MEI",
      "status": "ACTIVE",
      "legal_address": {
        "street_name": "Av. Corrientes",
        "street_number": 300,
        "floor": 1,
        "apartment": "A",
        "zip_code": 1414,
        "neighborhood": "Villa Crespo",
        "city": "CABA",
        "region": "Buenos Aires",
        "additional_info": "Torre 2",
        "country": "ARG"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total_pages": 1,
      "current_page": 0
    },
    "filter": [
      {
        "key": "status",
        "value": [
          "ACTIVE",
          "BLOCKED"
        ]
      }
    ]
  }
}

Obtener Compañía

Modificar Compañía