Empresas

Esta API te permitirá crear, eliminar y actualizar tus empresas. También podrás obtener empresas individualmente o una lista paginada con todas tus empresas.

Relacionado

• Guía rápida > Crea una empresa

POST
/v1/companies
GET
/v1/companies/:id
POST
/v1/companies/:id
DELETE
/v1/companies/:id
GET
/v2/apps/:clientId/companies

Si la empresa ya se encuentra registrada en la plataforma (el correo electrónico ya existe), se creará una relación sin modificar ningún otro dato.

Los atributos opcionales que no se hayan facilitado los pediremos posteriormente.

Resultado

Devolverá el identificador único si la creación de la empresa ha tenido éxito. Puede devolver un error si hay parámetros inválidos o si el correo electrónico ya existe y le pertenece a un profesional.

Terminal
$curl URL_API/api/v1/companies \>  -u CLIENT_SECRET: \>  -d "name"="Empresa de prueba" \>  -d "email"="company@danchiano.com" \>  -d "nif"="989898Z" \>  -d "image"="https://d347nhcygwz59.cloudfront.net/uploads/info-logo.png" \>  -d "country"="ES" \>  -d "province"="B" \>  -d "city"="Barcelona" \>  -d "employees"=1 \>  -d "sector"=71 \>  -d "firstname"="Nombre del contacto" \>  -d "lastname"="Apellidos del contacto"

JSON
 {   "created": "2024-09-02",   "companyId": APPLICANT_ID }

Actualiza la empresa especificada guardando los valores de los parámetros enviados. Cualquier parámetro no enviado no será actualizado.

Obtén los detalles de una empresa existente. Solo necesitarás facilitar el id de la empresa que obtuvo al crearla.

Resultado

Si el identificador es válido devolverá los datos de la empresa y los puestos jobs que ha creado.

Terminal
$curl URL_API/api/v1/companies/COMPANY_ID \>  -u CLIENT_SECRET:

JSON
   {     "address": null,     "city": null,     "companyId": COMPANY_ID,     "country": null,     "cp": null,     "created": "2021-06-10 16:02:17.909615+00:00",     "email": "testcompany@danchiano.com",     "employees": 3,     "firstname": null,     "jobs": [       {         "jobId": 61094,         "standard": false,         "test": true       }     ],     "lastname": null,     "name": "Empresa de prueba editada",     "nif": "123456",     "phone": null,     "province": null,     "sector": null   }

Elimina la empresa especificada de la aplicación.

Terminal
$curl URL_API/api/v1/companies/COMPANY_ID \>  -u CLIENT_SECRET: \>  -X DELETE

curl
 1200 OK

Resultado

Devolverá solo datos básicos de tus empresas.

Terminal
$curl URL_API/api/v2/apps/CLIENT_ID/companies?p=0 \>  -u CLIENT_SECRET:

JSON
   {     "pagination": {       "count": 3,       "currentPage": 0,       "totalPages": 1     },     "list": [       {         "id": 1328778,         "name": "Company renamed",         "email": "testcompany@danchiano.com",         "created": "2021-06-10T16:02:17.909Z",         "accessed": "2021-06-10T16:02:20.225Z",         "fullyRegistered": false,         "jobs": 1       },       {         "id": 1036018,         "name": "Coorve",         "email": "guillermo@coorve.com",         "created": "2020-11-09T23:00:00.000Z",         "accessed": "2020-11-09T23:00:00.000Z",         "fullyRegistered": true,         "jobs": 1       },       {         "id": 5,         "name": "PymeLegal",         "email": "pyme@legal.com",         "created": "2017-05-12T22:00:00.000Z",         "accessed": "2021-05-12T15:06:35.473Z",         "fullyRegistered": true,         "jobs": 43       }     ]   }