Tu API de enriquecimiento para impulsar tu producto y tu marketing
Busca empresas, enriquece una lista de dominios y encuentra negocios similares.
La API de Empresas está construida utilizando la arquitectura REST. Nuestras rutas aceptan cuerpos de solicitud codificados en formato de formulario y devuelven respuestas codificadas en formato JSON. Puede pasar de una función a otra con el menú de navegación a su izquierda. Se proporcionan ejemplos con respuestas reales en el lado derecho de la página.
Envíenos un mensaje en el cuadro de chat. Un desarrollador le responderá lo antes posible para responder sus preguntas.
Podemos ayudarlo a integrar nuestra API. Envíenos un mensaje en el cuadro de chat.
La API de las empresas utiliza tokens de API para autenticar las solicitudes. Puede gestionar sus tokens de API en sus parámetros o en el lado derecho de esta sección.
Hay dos formas de autenticar sus solicitudes HTTP a la API:
Al agregar un encabezado "Authorization". El encabezado "Authorization" se formatea como sigue: "Authorization: Basic MY-API-TOKEN" (reemplace "MY-API-TOKEN" con uno de los suyos).
Al enviar el token de API como un parámetro "GET". Como esto "?token=MY-API-TOKEN" (principalmente utilizado para probar rápidamente un endpoint).
Bueno saberlo
No se encontró ningún token API
Crea un token API para empezar a usar nuestros endpoints.
La API de Companies utiliza códigos de respuesta HTTP convencionales para indicar el éxito o fracaso de una solicitud de API. Generalmente, los códigos en el rango 2xx indican éxito. Los códigos en el rango 4xx indican un error que falló dada la información proporcionada (por ejemplo, se omitió un parámetro requerido). Los códigos en el rango 5xx indican un error en nuestros servidores (estos son raros).
Algunos errores 4xx que podrían manejarse programáticamente incluyen un código de error que explica brevemente qué salió mal.
Objeto de error
Para algunos errores que podrían manejarse programáticamente, un número que indica el código de error reportado.
403
Un mensaje que proporciona más detalles sobre el error.
Missing API token
El tipo de error devuelto (ver la lista a su derecha).
apiConnectionError
Valores posibles
The Companies API utiliza webhooks para notificarte sobre cambios o cuando una operación termina. Puedes gestionar tus webhooks en el lado derecho de esta sección o en tus ajustes.
Los webhooks son útiles para recibir los resultados de nuestros algoritmos. Por ejemplo, cuando una nueva empresa que has solicitado ha sido rastreada.
No se encontró ningún webhook
Crea un webhook para recibir una notificación para eventos importantes.
Encontrarás todas nuestras funcionalidades relacionadas con nuestra base de datos de empresas a continuación.
Busca empresas con una condición específica o por nombre. Recupera el perfil de una empresa en particular proporcionando su nombre de dominio o una de sus URLs de redes sociales.
¿También necesitas obtener empresas similares o incluso los patrones de correo electrónico que utilizan? ¡Nosotros también!
¿Necesitas buscar empresas ubicadas en un país específico para un sector de actividad específico y que usan una tecnología en particular? Combina nuestras condiciones y crea consultas de búsqueda potentes para identificarlas.
¿Quieres construir un motor de búsqueda de empresas potente en tu aplicación? Hemos escrito un guía para ayudarte a hacerlo.Parámetros de consulta
Un array de condiciones que las empresas deben cumplir.
Asegúrate de que este parámetro esté convertido a cadena y codificado.
Una lista de dominios separados por comas para excluir de los resultados.
/companies?domainsToExclude=amazon.com,pearson.com
Una lista de URLs de LinkedIn separadas por comas para excluir de los resultados.
/companies?linkedinToExclude=https://www.linkedin.com/company/amazon,https://www.linkedin.com/company/pearson
La página a recuperar (por defecto 1).
/companies?page=1
Una consulta de búsqueda adicional aplicada al nombre de la empresa o al dominio.
/companies?search=amazon
Defina los campos para buscar.
/companies?searchFields[]=domain&searchFields[]=name
Valores posibles
Devuelve una versión simplificada de las empresas (no se deduce ningún crédito, pero se aplican limitaciones en el plan gratuito). Es útil para visualizar los datos antes de recuperar la versión completa. Por defecto a false.
/companies?simplified=true
Valores posibles
El número de empresas a devolver (entre 1 y 100). Por defecto 10.
/companies?size=10
Un array de múltiples campos combinados para ordenar los resultados.
…/companies?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D
Asegúrate de que este parámetro esté convertido a cadena y codificado.
El campo para ordenar los resultados.
…/companies?sortKey=meta.score
Valores posibles
El orden para ordenar los resultados.
…/companies?sortOrder=asc
Valores posibles
Respuesta
La información de metadatos.
Las condiciones que las empresas deben cumplir.
Recupera un perfil de empresa proporcionando el nombre de la empresa. Puedes usar este endpoint si necesitas más información sobre la empresa, pero ten cuidado. Dos empresas pueden tener el mismo nombre, por ejemplo, Bolt. Por eso, esta función puede devolver varias empresas.
Parámetros de consulta
El nombre de la empresa.
…/companies/by-name?name=microsoft
La página a recuperar (por defecto 1).
/companies/by-name?page=1
Los países para filtrar las empresas. Puedes proporcionar varios países separados por comas. Por defecto a todos los países.
/companies/by-name?countries=us,fr,de
Valores posibles
Si se establece en true, el nombre de la empresa debe coincidir con las palabras buscadas. 'Bank of A' no devolverá Bank of America, pero 'Bank of' y 'Bank of America' lo harán. Por defecto a true.
/companies/by-name?exactWordsMatch=false
IDs de tus listas separados por comas que contienen las empresas a excluir de los resultados.
/companies/by-name?listsToExclude=3920,3925
attributes.searchFields
/companies?searchFields[]=domain&searchFields[]=name
Valores posibles
Devuelve una versión simplificada de las empresas (no se deduce ningún crédito, pero se aplican limitaciones en el plan gratuito). Es útil para visualizar los datos antes de recuperar la versión completa. Por defecto a false.
/companies/by-name?simplified=true
Valores posibles
El número de empresas a devolver (entre 1 y 25). Por defecto a 1.
/companies/by-name?name=amazon&size=2
Un array de múltiples campos combinados para ordenar los resultados.
…/companies/by-name?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D
Asegúrate de que este parámetro esté convertido a cadena y codificado.
El campo para ordenar los resultados.
…/companies/by-name?sortKey=meta.score
Valores posibles
El orden para ordenar los resultados.
…/companies/by-name?sortOrder=asc
Valores posibles
Respuesta
La información de metadatos.
Describe las empresas que estás buscando y nuestro modelo de IA las encontrará para ti. Puedes ajustar el umbral de similitud para mejorar la precisión de tus resultados.
Parámetros de consulta
El prompt que nuestro modelo de IA utilizará para buscar empresas.
…/companies/by-prompt?prompt=universities in the united states
Los identificadores separados por comas de tus listas que contienen las empresas a excluir de los resultados.
/companies/by-prompt?listsToExclude=3920,3925
La página a recuperar (por defecto 1).
/companies/by-prompt?page=1
El umbral de similitud a utilizar para la búsqueda (entre 0 y 1). Por defecto a 0.75.
/companies/by-prompt?similarity=0.75
Si se debe devolver una versión simplificada del perfil de la empresa. Por defecto a false.
/companies/by-prompt?simplified=true
El número de empresas a devolver (entre 1 y 25). Por defecto a 10.
/companies/by-prompt?size=10
Un array de múltiples campos combinados para ordenar los resultados.
…/companies/by-prompt?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D
Asegúrate de que este parámetro esté convertido a cadena y codificado.
El campo para ordenar los resultados.
…/companies/by-prompt?sortKey=meta.score
Valores posibles
El orden para ordenar los resultados.
…/companies/by-prompt?sortOrder=asc
Valores posibles
Respuesta
La información de metadatos.
Envía uno o más nombres de dominio y te devolvemos una lista de empresas similares.
Parámetros de consulta
Una lista de nombres de dominio separados por comas.
…/companies/similar?domains[]=microsoft.com&domains[]=wix.com
La página a recuperar (por defecto 1).
/companies/similar?domains[]=…&page=1
Return a simplified version of the companies (no credits deducted but limitation are applied on the free plan). It is useful for previewing the data before fetching the full version. Default to false.
/companies/similar?domains[]=…&simplified=true
Valores posibles
El número de empresas similares a devolver (entre 1 y 100). Por defecto a 10.
/companies/similar?domains[]=…&size=50
Un array de múltiples campos combinados para ordenar los resultados.
…/companies/similar?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D
Asegúrate de que este parámetro esté convertido a cadena y codificado.
El campo para ordenar los resultados.
…/companies/similar?sortKey=meta.score
Valores posibles
El orden para ordenar los resultados.
…/companies/similar?sortOrder=asc
Valores posibles
Respuesta
Las empresas similares para tu lista de nombres de dominio.
Explorar todos los puntos de datosLa información de metadatos.
Cuenta las empresas que coinciden con su filtro. Útil si estás construyendo tu propio motor de búsqueda de empresas.
Parámetros de consulta
Un array de condiciones que las empresas deben cumplir.
Asegúrate de que este parámetro esté convertido a cadena y codificado.
Una consulta de búsqueda adicional aplicada al nombre de la empresa o al dominio.
/companies/count?search=amazon
Defina los campos para buscar.
/companies/count?searchFields[]=domain&searchFields[]=name
Valores posibles
Respuesta
El número de empresas que coinciden con las condiciones.
Enriquece una empresa enviándonos su nombre de dominio. El nombre de dominio es un mejor identificador que el nombre de la empresa porque es único y menos susceptible a errores de tipeo.
Parámetros de consulta
El nombre de dominio de la empresa (por ejemplo: apple.com, microsoft.com).
microsoft.com
Cuando se establece en true, devuelve una versión simplificada de los datos de la empresa. La llamada es gratuita y no se descontarán créditos.
/companies/microsoft.com?simplified=true
Cuando se establece en true, activa una actualización en tiempo real de los datos de la empresa, incluyendo rastreo del sitio web, análisis de redes sociales y enriquecimiento mediante IA. Nota: esta operación cuesta 10 créditos adicionales por solicitud.
/companies/microsoft.com?refresh=true
Respuesta
Información general sobre la empresa.
Datos analíticos y rendimiento del sitio web.
Información sobre las aplicaciones que ofrece la empresa.
Recursos de la empresa, incluyendo activos digitales.
Códigos de clasificación industrial estándar para la empresa y otros códigos de identificación.
Detalles sobre empresas relacionadas como adquisiciones y subsidiarias.
Información de contacto incluyendo correos electrónicos y teléfonos.
Contenido proporcionado por la empresa como blogs, podcasts y más.
Descripciones de la empresa y palabras clave asociadas convertidas al inglés con nuestra IA.
Detalles sobre el nombre de dominio de la empresa.
Datos financieros e información de ingresos sobre la empresa.
Ubicaciones geográficas y sedes de la empresa.
Información meta sobre la empresa.
Información adicional sobre la empresa que no pudimos categorizar.
Enlaces de redes sociales de la empresa y métricas.
Tecnologías utilizadas por la empresa.
URLs relacionadas con la empresa.
Enriquecer una empresa enviando un email.
¿Quieres enriquecer a tus usuarios al registrarse con datos de empresa precisos? Hemos escrito un guía para ayudarte a hacerlo.Parámetros de consulta
Cuando se establece en true, devuelve una versión simplificada de los datos de la empresa. La llamada es gratuita y no se descontarán créditos.
/companies/[email protected]&simplified=true
Cuando se establece en true, activa una actualización en tiempo real de los datos de la empresa, incluyendo rastreo del sitio web, análisis de redes sociales y enriquecimiento mediante IA. Nota: esta operación cuesta 10 créditos adicionales por solicitud.
/companies/microsoft.com?refresh=true
Respuesta
El perfil de la empresa desde nuestra base de datos.
Explorar todos los puntos de datosInformación adicional sobre el email.
Recupera el perfil de una empresa enviándonos una URL de red social (ver la lista de abajo para los que aceptamos).
Parámetros de consulta
La URL Dribbble de la empresa.
/companies/by-social?dribbble=https://dribbble.com/microsoft
La URL Facebook de la empresa.
/companies/by-social?facebook=https://www.facebook.com/microsoft
La URL GitHub de la empresa.
/companies/by-social?github=https://github.com/microsoft
La URL Instagram de la empresa.
/companies/by-social?instagram=https://www.instagram.com/microsoft
La URL LinkedIn de la empresa. Gestionamos tanto las URLs alfa (/company/microsoft) como los identificadores numéricos (/company/6585).
/companies/by-social?linkedin=https://www.linkedin.com/company/microsoft
La URL Pinterest de la empresa.
/companies/by-social?pinterest=https://www.pinterest.com/microsoft
La URL Snapchat de la empresa.
/companies/by-social?snapchat=https://www.snapchat.com/add/microsoft
La URL TikTok de la empresa.
/companies/by-social?tiktok=https://www.tiktok.com/@microsoft
La URL Twitter de la empresa.
/companies/by-social?twitter=https://twitter.com/microsoft
La URL Wellfound de la empresa.
/companies/by-social?wellfound=https://wellfound.com/company/microsoft
La URL YouTube de la empresa.
/companies/by-social?youtube=https://www.youtube.com/@microsoft
Cuando se establece en true, activa una actualización en tiempo real de los datos de la empresa, incluyendo rastreo del sitio web, análisis de redes sociales y enriquecimiento mediante IA. Nota: esta operación cuesta 10 créditos adicionales por solicitud.
/companies/by-social?linkedin=https://www.linkedin.com/company/microsoft&refresh=true
Respuesta
Información general sobre la empresa.
Datos analíticos y rendimiento del sitio web.
Información sobre las aplicaciones que ofrece la empresa.
Recursos de la empresa, incluyendo activos digitales.
Códigos de clasificación industrial estándar para la empresa y otros códigos de identificación.
Detalles sobre empresas relacionadas como adquisiciones y subsidiarias.
Información de contacto incluyendo correos electrónicos y teléfonos.
Contenido proporcionado por la empresa como blogs, podcasts y más.
Descripciones de la empresa y palabras clave asociadas convertidas al inglés con nuestra IA.
Detalles sobre el nombre de dominio de la empresa.
Datos financieros e información de ingresos sobre la empresa.
Ubicaciones geográficas y sedes de la empresa.
Información meta sobre la empresa.
Información adicional sobre la empresa que no pudimos categorizar.
Enlaces de redes sociales de la empresa y métricas.
Tecnologías utilizadas por la empresa.
URLs relacionadas con la empresa.
Envía un nombre de dominio y recupera todos los formatos de correo electrónico que utilizan con el porcentaje de uso.
Parámetros de consulta
El nombre de dominio de la empresa.
…/companies/microsoft.com/email-patterns
Respuesta
Los formatos de email utilizados.
Hacer preguntas sobre una empresa usando nuestro modelo de IA. Puedes especificar el modelo a usar (pequeño o grande) y opcionalmente proporcionar campos para estructurar la respuesta. El modelo grande es más caro pero proporciona respuestas más detalladas.
Parámetros de consulta
El dominio de la empresa sobre la que quieres hacer una pregunta.
…/companies/microsoft.com/ask
La pregunta a hacer al modelo de IA.
What products does this company offer?
Un array de definiciones de campos simplificadas para la respuesta.
Si no lo proporcionas, el modelo generará un esquema de respuesta basado en tu pregunta.
Los posibles valores para cada campo:
- `description`: Una descripción opcional del campo.
- `key`: Una cadena de caracteres, generalmente en camelCase. (required)
- `type`: El tipo de campo. (required)
[{"description":"The products that the company offers","key":"products","type":"array|string"}]
El modelo a utilizar para la pregunta.
large
Valores posibles
Respuesta
La respuesta a la pregunta en una forma estructurada.
La información meta sobre la respuesta.
Este endpoint te permite recuperar insights generados por IA sobre una empresa. Nuestra IA analiza el sitio web de la empresa y otras fuentes autorizadas para extraer y sintetizar información clave en un contexto completo. Esto incluye detalles sobre su modelo de negocio, mercado objetivo, ventajas competitivas y otras estrategias que pueden no ser evidentes desde datos de la empresa sin procesar.
Parámetros de consulta
El dominio de la empresa para la que se desea recuperar el contexto.
…/companies/microsoft.com/context
Respuesta
El contexto de la empresa.
La información meta sobre la respuesta.
Analice y obtenga información soxbre empresas que coincidan con sus criterios especificados. Puede explorar varios atributos incluyendo tipo de negocio, industria, número de empleados y más. Este endpoint también permite exportar datos en múltiples formatos.
Parámetros de consulta
El atributo de análisis para agregar datos. Determina qué campo se utilizará para agrupar y analizar las empresas.
Valores posibles
Una matriz de condiciones para filtrar las empresas.
Asegúrate de que este parámetro esté convertido a cadena y codificado.
Filtrar análisis a listas específicas.
El número máximo de empresas a incluir en el análisis (entre 1 y 10,000). El valor por defecto es 100.
Valores posibles
El orden de clasificación de los resultados.
Valores posibles
Respuesta
Matriz de métricas agregadas (recuentos y porcentajes) para cada valor del atributo especificado.
Metadatos adicionales sobre los resultados.
Exporte datos de análisis sobre empresas en varios formatos. Puede elegir atributos específicos para exportar u obtener una exportación completa de todos los atributos de análisis. El endpoint devuelve una descarga de archivo en el formato elegido.
Parámetros de consulta
El ID de la acción para filtrar los análisis.
Una matriz de atributos de análisis para exportar. Requerido si full no es verdadero.
Valores posibles
El formato del archivo exportado (por defecto json).
Valores posibles
Si se deben exportar todos los atributos de análisis.
Filtrar análisis a lista específica.
Una matriz de condiciones para filtrar las empresas.
Asegúrate de que este parámetro esté convertido a cadena y codificado.
Le nombre de résultats à retourner.
L'ordre de tri des résultats.
Valores posibles
Respuesta
Un array de puntos de datos de análisis que contienen conteos y porcentajes para cada valor
Metadatos adicionales sobre los resultados.
A continuación, encontrarás una visión general completa de las acciones que puedes realizar con las empresas.
Estas acciones son particularmente poderosas para automatizar procesos dentro de tu producto utilizando nuestra API.
Te permiten no solo enriquecer empresas que no están todavía en nuestra base de datos, sino también realizar un enriquecimiento más detallado en caso de que sea necesario (como extraer productos para un sitio web de comercio electrónico).
Este endpoint te permite solicitar una acción para una sola empresa, múltiples empresas o una lista completa de empresas.
Parámetros del cuerpo
Los dominios que necesitan ser procesados. Si pasas más de 100K dominios, la solicitud se dividirá en múltiples acciones.
["pearson.com","united.com"]
Indica si estás solicitando una estimación de precio.
Valores posibles
El tipo de tarea a realizar.
Valores posibles
El ID de la lista a procesar.
42
Respuesta
Las acciones que han sido desencadenadas por la solicitud.
Indica si estás solicitando una estimación de precio.
Este endpoint te permite recuperar tus solicitudes de acciones más recientes.
Parámetros de consulta
Si se deben obtener los detalles completos de la acción.
false
Los IDs de las acciones a obtener.
[1,2]
El ID de la lista para la que se obtendrán las acciones.
1
La página a recuperar (por defecto es 1).
1
El número de acciones que se devolverán (entre 1 y 25). Por defecto es 10.
10
El estado de las acciones a recuperar.
Valores posibles
Respuesta
La lista de acciones.
La información de metadatos.
Busca industrias específicas y obtén información como el número de empresas que contiene.
Busca en nuestra base de datos de industrias y obtén información como el número de empresas que contiene. Los resultados se ordenan por "companies_count".
Parámetros de consulta
La página a recuperar (por defecto 1).
/industries?page=1
Una consulta de búsqueda adicional aplicada al nombre de la industria.
/industries?search=saas
El número de industrias a devolver (entre 1 y 100). Por defecto 25.
/industries?size=10
Respuesta
Las industrias que coinciden con tus criterios.
La información de metadatos.
Descubre industrias similares con nuestra API. Identifica sectores relacionados y amplía tus oportunidades comerciales.
Parámetros de consulta
Las industrias para comparar (máx. 10).
/industries/similar?industries[]=saas&industries[]=fintech
La página a recuperar (por defecto 1).
/industries/similar?page=1
El número de industrias a devolver (entre 1 y 100). Por defecto a 25.
/industries/similar?size=10
Respuesta
Las industrias que coinciden con tus criterios.
La información de metadatos.
Actualmente rastreamos 369 tecnologías. Si necesitas una tecnología que no esté listada, no dudes en hablar con nosotros ya que generalmente nos lleva menos de 48 horas agregarla.
Navega por las tecnologías que identificamos y obtén información como el número de empresas que la utilizan.
Parámetros de consulta
La página a recuperar (por defecto 1).
/technologies?page=1
Una consulta de búsqueda adicional aplicada al nombre de la tecnología.
/technologies?search=shopify
El número de tecnologías a devolver (entre 1 y 100). Por defecto 25.
/technologies?size=10
Respuesta
Las tecnologías que identificamos que coinciden con tus condiciones.
La información de metadatos.
Los siguientes endpoints te permiten buscar todas nuestras localizaciones: ciudades, condados, estados, países y continentes.
Busca nuestras ciudades para filtrar empresas en una ubicación específica.
Parámetros de consulta
La página a obtener (por defecto 1).
Una consulta de búsqueda adicional aplicada al nombre de la ciudad.
El número de ciudades a devolver (entre 1 y 20). Por defecto 10.
Respuesta
Las ciudades que coinciden con tus condiciones.
La información de metadatos.
Busca en nuestra base de datos de departamentos para filtrar empresas en un lugar específico.
Parámetros de consulta
La página a recuperar (por defecto 1).
Una consulta de búsqueda adicional aplicada al nombre del departamento.
El número de departamentos a devolver (entre 1 y 20). Por defecto 10.
Respuesta
Los departamentos que coinciden con tus criterios.
La información de metadatos.
Busca en nuestra base de datos de estados para filtrar empresas en un lugar específico.
Parámetros de consulta
La página a recuperar (por defecto 1).
Una consulta de búsqueda adicional aplicada al nombre del estado.
El número de estados a devolver (entre 1 y 20). Por defecto 10.
Respuesta
Los estados que coinciden con tus criterios.
La información de metadatos.
Busca en nuestra base de datos de países para filtrar empresas en un lugar específico.
Parámetros de consulta
La página a recuperar (por defecto 1).
Una consulta de búsqueda adicional aplicada al nombre del país.
El número de países a devolver (entre 1 y 20). Por defecto 10.
Respuesta
Los países que coinciden con tus criterios.
La información de metadatos.
Busca en nuestros continentes para filtrar empresas en una ubicación específica.
Parámetros de consulta
La página que se va a buscar (por defecto 1).
Una consulta de búsqueda adicional aplicada al nombre del continente.
La cantidad de continentes que se devolverán (entre 1 y 20). Por defecto 10.
Respuesta
Los continentes que coinciden con tus condiciones.
La información de metadatos.
Encuentra profesiones específicas y obtén información como el número de empresas que contiene.
Envíanos una profesión (por ejemplo, director general) y recupera información adicional como los departamentos y los niveles de responsabilidad. Nosotros soportamos los siguientes idiomas: inglés, francés y español.
Parámetros de consulta
El nombre de la profesión.
/job-titles/enrich?name=chief%20executive%20officer
Respuesta
The job title's department.
marketing
Valores posibles
The job title's secondary department.
content marketing
Valores posibles
The job title's english name.
The job title's spanish name.
The job title's french name.
The job title's seniority level.
Valores posibles
Las empresas pueden ser guardadas en tus listas. Los siguientes endpoints te permiten recuperar tus listas y gestionar las empresas que pertenezcan a ellas.
Este endpoint te permite recuperar las listas que pertenezcan a tu equipo.
Parámetros de consulta
La página a recuperar (por defecto: 1).
/lists?page=1
El número de listas a recuperar (entre 1 y 100). Por defecto a 10.
/lists?size=10
Respuesta
Las listas que pertenezcan a tu equipo.
La información de metadatos.
Este endpoint te permite crear una lista de empresas.
Parámetros del cuerpo
Si la lista es dinámica o no. Si se establece en true, la lista se actualizará automáticamente cuando se agreguen nuevas empresas a la base de datos.
Valores posibles
El nombre de la lista.
El tipo de lista a crear.
Valores posibles
Respuesta
The analytics of the list.
When the list was created.
2022-02-22T07:23:52.000+00:00
If the list is dynamic or static.
true
The id of the list.
3838
If the list has been imported.
true
The integrations associated with the list.
The name of the list
SaaS with 100k+ MRR
The process active status of the list (for internal use).
true
The process initialized flag (for internal use).
true
When the list is being processed.
2022-02-22T07:23:52.000+00:00
The query used to generate the list.
Este endpoint te permite recuperar las empresas que pertenezcan a tu lista.
Parámetros de consulta
La página a recuperar (por defecto: 1).
/lists/:listId/companies?page=1
El número de empresas a recuperar (entre 1 y 100). Por defecto a 10.
/lists/:listId/companies?size=10
La consulta para filtrar las empresas dentro de tu lista.
Asegúrate de que este parámetro esté convertido a cadena y codificado.
Un array de múltiples campos combinados para ordenar los resultados.
…/lists/:listId/companies?sortFields=%5B%7B%22key%22%3A%22meta.score%22%2C%22order%22%3A%22desc%22%7D%5D
Asegúrate de que este parámetro esté convertido a cadena y codificado.
El campo para ordenar los resultados.
…/lists/:listId/companies?sortKey=meta.score
Valores posibles
El orden para ordenar los resultados.
…/lists/:listId/companies?sortOrder=asc
Valores posibles
Respuesta
La información de metadatos.
Use este endpoint para gestionar empresas en sus listas añadiendo (attaching) o eliminando (detaching) usando sus dominios o IDs. Puede modificar hasta 1,000 empresas por petición API.
Parámetros de consulta
La acción a realizar sobre las empresas: 'attach' para agregarlas a la lista, o 'detach' para eliminarlas de la lista.
Valores posibles
Un array de dominios de empresas (e.g. ['microsoft.com', 'apple.com']) para agregar o eliminar de la lista. Máximo 1,000 dominios.
Un array de IDs de empresas para agregar o eliminar de la lista (cada ID para una empresa está disponible en metas.mysqlId). Máximo 1,000 IDs de empresa.
Respuesta
The analytics of the list.
When the list was created.
2022-02-22T07:23:52.000+00:00
If the list is dynamic or static.
true
The id of the list.
3838
If the list has been imported.
true
The integrations associated with the list.
The name of the list
SaaS with 100k+ MRR
The process active status of the list (for internal use).
true
The process initialized flag (for internal use).
true
When the list is being processed.
2022-02-22T07:23:52.000+00:00
The query used to generate the list.
Estos endpoints te permiten gestionar y recuperar información detallada sobre el equipo asociado a tu token API.
Este endpoint te permite recuperar el equipo asociado a tu token API.
Respuesta
El país del equipo.
us
La fecha de creación del equipo.
2020-06-29 08:21:01
Los créditos del equipo.
500000
Si el equipo está suscrito a un plan de pago.
true
El id del equipo.
1
El nombre del equipo.
Jay Gatsby Enterprises
La URL del sitio web del equipo.
https://www.jaygatsbyenterprises.com
Nuestros endpoints de utilidades proporcionan herramientas útiles e información sobre nuestra API. Estos incluyen la verificación del estado de salud de la API y la obtención de la especificación OpenAPI.
Verifica el estado de salud de nuestra API y sus diversos servicios.
Respuesta
Estado de salud general de la API.
Nombre del nodo que responde a la solicitud.
Informe de salud detallado para cada servicio.
Obtén la especificación OpenAPI de nuestra API, que proporciona una descripción detallada de todos los endpoints disponibles, parámetros de solicitud y formatos de respuesta.
Respuesta
Componentes reutilizables utilizados en toda la especificación de la API.
Documentación externa adicional.
Metadatos sobre la API.
La versión de la especificación OpenAPI.
Las rutas y operaciones disponibles para la API.
Una matriz de objetos de servidor, que proporcionan información de conectividad a un servidor de destino.
Webhooks entrantes que pueden recibirse como parte de esta API.