API Clinicorp

https://sistema.clinicorp.com/api-docs
Admin
API Clinicorp provides programmatic access to manage clinic operations, patient data, appointments,...
Tokens:3,555
Snippets:17
Trust Score:8
Update:10 months ago
Show doc for...
Tokens:
Raw
### Product Orders

Source: https://sistema.clinicorp.com/api-docs/index

Endpoint for creating product orders.

```APIDOC
## Products API

### Create Product Order

### Method
POST

### Endpoint
/products/orders

### Description
Creates a new purchase order for products.

### Request Body
- **order_details** (object) - Required - Details of the product order.

### Response
#### Success Response (200)
- **order_id** (string) - The ID of the created order.
- **message** (string) - Confirmation message.
```

--------------------------------

### Migration Services

Source: https://sistema.clinicorp.com/api-docs/index

Endpoints for handling data migration processes.

```APIDOC
## Migration API

### Upload Migration File

### Method
POST

### Endpoint
/migration/file/upload

### Description
Uploads a file for data migration.

### Request Body
- **file** (file) - Required - The file to upload.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

### Process Migration File

### Method
POST

### Endpoint
/migration/file

### Description
Processes a migration file.

### Request Body
- **file_details** (object) - Required - Details about the file to process.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

### Establish Migration Connection

### Method
POST

### Endpoint
/migration/connection

### Description
Establishes a connection for data migration.

### Request Body
- **connection_details** (object) - Required - Details for the migration connection.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
```

--------------------------------

### Business Information

Source: https://sistema.clinicorp.com/api-docs/index

Endpoints for retrieving business-related information, including available times and chairs.

```APIDOC
## Business Information API

### List Available Times

### Method
GET

### Endpoint
/business/list_available_times

### Description
Retrieves a list of available times for business operations.

### Response
#### Success Response (200)
- **times** (array) - A list of available time slots.

### List Chairs

### Method
GET

### Endpoint
/business/list_chairs

### Description
Retrieves a list of available chairs.

### Response
#### Success Response (200)
- **chairs** (array) - A list of chair identifiers.

### List Businesses

### Method
GET

### Endpoint
/business/list

### Description
Retrieves a list of businesses.

### Response
#### Success Response (200)
- **businesses** (array) - A list of business objects.
```

--------------------------------

### List Users

Source: https://sistema.clinicorp.com/api-docs/index

Retrieves a list of users associated with the subscriber.

```APIDOC
## GET /security/list_users

### Description
Returns the list of users for the subscriber.

### Method
GET

### Endpoint
/security/list_users

### Parameters
#### Query Parameters
(No query parameters documented)

#### Request Body
(No request body documented)

### Response
#### Success Response (200)
- **users** (array) - A list of user objects.
  - **id** (integer) - The user's ID.
  - **name** (string) - The user's name.
  - **email** (string) - The user's email address.

#### Response Example
{
  "users": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "john.doe@example.com"
    }
  ]
}
```

--------------------------------

### Professional Information

Source: https://sistema.clinicorp.com/api-docs/index

Endpoint for listing all professionals.

```APIDOC
## Professional API

### List All Professionals

### Method
GET

### Endpoint
/professional/list_all_professionals

### Description
Retrieves a list of all professionals.

### Response
#### Success Response (200)
- **professionals** (array) - A list of professional objects.
```

--------------------------------

### Appointment Management

Source: https://sistema.clinicorp.com/api-docs/index

Endpoints for managing appointments, including scheduling, confirmation, and cancellation.

```APIDOC
## Appointment Management API

### List Appointment Categories

### Method
GET

### Endpoint
/appointment/list_categories

### Description
Retrieves a list of appointment categories.

### Response
#### Success Response (200)
- **categories** (array) - A list of appointment category objects.

### List Appointment Information

### Method
GET

### Endpoint
/appointment/list_info

### Description
Retrieves general appointment information.

### Response
#### Success Response (200)
- **info** (array) - A list of appointment information objects.

### Schedule Occupation

### Method
GET

### Endpoint
/appointment/schedule_occupation

### Description
Retrieves information about schedule occupation.

### Response
#### Success Response (200)
- **occupation** (object) - Schedule occupation details.

### List Appointments

### Method
GET

### Endpoint
/appointment/list

### Description
Retrieves a list of all appointments.

### Response
#### Success Response (200)
- **appointments** (array) - A list of appointment objects.

### Create Online Scheduling

### Method
POST

### Endpoint
/appointment/create_online_scheduling

### Description
Creates a new online scheduling for an appointment.

### Request Body
- **details** (object) - Required - Details of the online scheduling.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

### Get Available Times Calendar

### Method
GET

### Endpoint
/appointment/get_avaliable_times_calendar

### Description
Retrieves available times for appointments in a calendar view.

### Response
#### Success Response (200)
- **available_times** (array) - A list of available time slots.

### Get Available Days

### Method
GET

### Endpoint
/appointment/get_avaliable_days

### Description
Retrieves a list of available days for appointments.

### Response
#### Success Response (200)
- **available_days** (array) - A list of available days.

### Get Appointment

### Method
GET

### Endpoint
/appointment/get_appointment

### Description
Retrieves details of a specific appointment.

### Parameters
#### Query Parameters
- **appointment_id** (string) - Required - The ID of the appointment.

### Response
#### Success Response (200)
- **appointment** (object) - The appointment details.

### Confirm Appointment

### Method
POST

### Endpoint
/appointment/confirm_appointment

### Description
Confirms an existing appointment.

### Request Body
- **appointment_id** (string) - Required - The ID of the appointment to confirm.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

### Cancel Appointment

### Method
POST

### Endpoint
/appointment/cancel_appointment

### Description
Cancels an existing appointment.

### Request Body
- **appointment_id** (string) - Required - The ID of the appointment to cancel.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

### Create Appointment by API

### Method
POST

### Endpoint
/appointment/create_appointment_by_api

### Description
Creates an appointment via the API.

### Request Body
- **details** (object) - Required - Details for creating the appointment.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

### Change Appointment Status

### Method
GET

### Endpoint
/appointment/change_status

### Description
Changes the status of an appointment.

### Parameters
#### Query Parameters
- **appointment_id** (string) - Required - The ID of the appointment.
- **status** (string) - Required - The new status for the appointment.

### Response
#### Success Response (200)
- **message** (string) - Status update message.

### List Appointment Statuses

### Method
GET

### Endpoint
/appointment/status_list

### Description
Retrieves a list of available appointment statuses.

### Response
#### Success Response (200)
- **statuses** (array) - A list of status strings.
```

--------------------------------

### File Upload

Source: https://sistema.clinicorp.com/api-docs/index

Endpoint for uploading files.

```APIDOC
## File Upload API

### Upload File

### Method
POST

### Endpoint
/file/upload

### Description
Uploads a file to the system.

### Request Body
- **file** (file) - Required - The file to upload.

### Response
#### Success Response (200)
- **file_url** (string) - The URL of the uploaded file.
```

--------------------------------

### Financial Management

Source: https://sistema.clinicorp.com/api-docs/index

Endpoints for retrieving various financial data, including invoices, payments, and cash flow.

```APIDOC
## Financial API

### List Invoices

### Method
GET

### Endpoint
/financial/list_invoices

### Description
Retrieves a list of financial invoices.

### Response
#### Success Response (200)
- **invoices** (array) - A list of invoice objects.

### Average Installments

### Method
GET

### Endpoint
/financial/average_installments

### Description
Retrieves the average installment information.

### Response
#### Success Response (200)
- **average_installments** (object) - Average installment data.

### List Receipts

### Method
GET

### Endpoint
/financial/list_receipt

### Description
Retrieves a list of financial receipts.

### Response
#### Success Response (200)
- **receipts** (array) - A list of receipt objects.

### List Cash Flow

### Method
GET

### Endpoint
/financial/list_cash_flow

### Description
Retrieves financial cash flow data.

### Response
#### Success Response (200)
- **cash_flow** (array) - Cash flow data.

### List Payments

### Method
GET

### Endpoint
/financial/list_payments

### Description
Retrieves a list of financial payments.

### Response
#### Success Response (200)
- **payments** (array) - A list of payment objects.

### List Financial Summary

### Method
GET

### Endpoint
/financial/list_summary

### Description
Retrieves a summary of financial data.

### Response
#### Success Response (200)
- **summary** (object) - Financial summary data.
```

--------------------------------

### CRM Management

Source: https://sistema.clinicorp.com/api-docs/index

Endpoints for managing CRM activities, including adding leads and listing campaigns.

```APIDOC
## CRM API

### Add Lead

### Method
POST

### Endpoint
/crm/add_leads

### Description
Adds a new lead to the CRM.

### Request Body
- **lead_data** (object) - Required - Data for the new lead.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

### List Active Campaigns

### Method
GET

### Endpoint
/crm/list_active_campaigns

### Description
Retrieves a list of active CRM campaigns.

### Response
#### Success Response (200)
- **campaigns** (array) - A list of active campaign objects.
```

--------------------------------

### Payment Management

Source: https://sistema.clinicorp.com/api-docs/index

Endpoints for retrieving payment-related data.

```APIDOC
## Payment API

### List Payments

### Method
GET

### Endpoint
/payment/list

### Description
Retrieves a list of payments.

### Response
#### Success Response (200)
- **payments** (array) - A list of payment objects.

### List Reconcile Claims

### Method
GET

### Endpoint
/payment/list_reconcile_claim

### Description
Retrieves a list of claims for reconciliation.

### Response
#### Success Response (200)
- **claims** (array) - A list of claim objects for reconciliation.
```

--------------------------------

### Patient Management

Source: https://sistema.clinicorp.com/api-docs/index

Endpoints for managing patient information, including creation and listing appointments and estimates.

```APIDOC
## Patient Management API

### Get Patient

### Method
GET

### Endpoint
/patient/get

### Description
Retrieves details for a specific patient.

### Parameters
#### Query Parameters
- **patient_id** (string) - Required - The ID of the patient.

### Response
#### Success Response (200)
- **patient** (object) - The patient's details.

### List Patient Birthdays

### Method
GET

### Endpoint
/patient/birthdays

### Description
Retrieves a list of patient birthdays.

### Response
#### Success Response (200)
- **birthdays** (array) - A list of patient birthday information.

### Create Patient

### Method
POST

### Endpoint
/patient/create

### Description
Creates a new patient record.

### Request Body
- **patient_data** (object) - Required - Data for the new patient.

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

### List Patient Appointments

### Method
GET

### Endpoint
/patient/list_appointments

### Description
Retrieves a list of appointments for a specific patient.

### Parameters
#### Query Parameters
- **patient_id** (string) - Required - The ID of the patient.

### Response
#### Success Response (200)
- **appointments** (array) - A list of appointment objects for the patient.

### List Patient Estimates

### Method
GET

### Endpoint
/patient/list_estimates

### Description
Retrieves a list of estimates associated with a specific patient.

### Parameters
#### Query Parameters
- **patient_id** (string) - Required - The ID of the patient.

### Response
#### Success Response (200)
- **estimates** (array) - A list of estimate objects for the patient.
```

--------------------------------

### Estimates Management

Source: https://sistema.clinicorp.com/api-docs/index

Endpoints for retrieving and listing estimate data.

```APIDOC
## Estimates API

### Get Estimate

### Method
GET

### Endpoint
/estimates/get

### Description
Retrieves specific estimate data.

### Parameters
#### Query Parameters
- **id** (string) - Required - The ID of the estimate to retrieve.

### Response
#### Success Response (200)
- **estimate** (object) - The estimate details.

### List Estimates

### Method
GET

### Endpoint
/estimates/list

### Description
Retrieves a list of all estimates.

### Response
#### Success Response (200)
- **estimates** (array) - A list of estimate objects.
```

--------------------------------

### Sales Data

Source: https://sistema.clinicorp.com/api-docs/index

Endpoints for retrieving sales-related data, including estimates and revenue.

```APIDOC
## Sales API

### Estimates and Conversion

### Method
GET

### Endpoint
/sales/estimates_and_conversion

### Description
Retrieves data on estimates and their conversion rates.

### Response
#### Success Response (200)
- **data** (object) - Sales data including estimates and conversion.

### Expertise Revenue

### Method
GET

### Endpoint
/sales/expertise_revenue

### Description
Retrieves revenue data broken down by expertise.

### Response
#### Success Response (200)
- **revenue_by_expertise** (object) - Revenue data categorized by expertise.
```

--------------------------------

### Group Management

Source: https://sistema.clinicorp.com/api-docs/index

Endpoints for retrieving information about subscribers, clinics, and group data.

```APIDOC
## Group Management API

### List Subscribers and Clinics

### Method
GET

### Endpoint
/group/list_subscribers_clinics

### Description
Returns information about subscribers and their associated clinics.

### Response
#### Success Response (200)
- **data** (array) - List of subscriber and clinic information.

### List Subscribers

### Method
GET

### Endpoint
/group/list_subscribers

### Description
Returns a list of subscribers.

### Response
#### Success Response (200)
- **data** (array) - List of subscriber information.
```

--------------------------------

### Operational Data

Source: https://sistema.clinicorp.com/api-docs/index

Endpoints for retrieving operational data related to goals and performance.

```APIDOC
## Operational API

### List Missed Goals

### Method
GET

### Endpoint
/operational/list_misses_goals

### Description
Retrieves a list of missed operational goals.

### Response
#### Success Response (200)
- **missed_goals** (array) - A list of missed goals.

### List Sales Goals

### Method
GET

### Endpoint
/operational/list_sales_goals

### Description
Retrieves a list of sales goals.

### Response
#### Success Response (200)
- **sales_goals** (array) - A list of sales goals.
```

--------------------------------

### Procedures Management

Source: https://sistema.clinicorp.com/api-docs/index

Endpoints for retrieving information about medical procedures and specialties.

```APIDOC
## Procedures API

### List Procedures

### Method
GET

### Endpoint
/procedures/list

### Description
Retrieves a list of available medical procedures.

### Response
#### Success Response (200)
- **procedures** (array) - A list of procedure objects.

### List Procedure Specialties

### Method
GET

### Endpoint
/procedures/list_specialties

### Description
Retrieves a list of medical procedure specialties.

### Response
#### Success Response (200)
- **specialties** (array) - A list of specialty objects.
```

--------------------------------

### Analytics

Source: https://sistema.clinicorp.com/api-docs/index

Endpoint for retrieving analytics data related to the subscriber's clinics.

```APIDOC
## Analytics API

### List Analytics Results

### Method
GET

### Endpoint
/analytics/list_results

### Description
Returns analytics data for the subscriber's clinics.

### Response
#### Success Response (200)
- **results** (array) - An array of analytics result objects.
```
Tokens:
Raw