REST API para M&S CRM

API REST sobre HTTPS con JSON. Métodos HTTP y códigos de estado estándar. Token por instalación.

Introducción

La API de M&S opera sobre HTTPS y utiliza JSON como formato de datos. Es una API RESTful y emplea métodos y códigos de estado HTTP para expresar solicitudes y respuestas. Un token se vincula a una instalación completa de M&S. Para interactuar con otra instalación diferente, debes crear un token en esa instalación.

Autenticación

Usa el authtoken en el encabezado de cada solicitud.

Header: authtoken: TU_TOKEN

Para operaciones POST/PUT se utiliza multipart/form-data.

Rutas con index.php/: si tu instalación usa URLs enrutadas con index.php/, inclúyelo en la ruta de tus solicitudes. Algunos servidores ignoran la barra final; si recibes Route not found, prueba añadir o quitar index.php/ o la barra de cierre.

Ejemplo de uso

Escenario: Con token jEheVytlAoFl7F8MqUQ7jAo2hOXAS, listar tickets:

curl -H "authtoken: jEheVytlAoFl7F8MqUQ7jAo2hOXAS" \
"https://crm.myscreators.com/index.php/api/tickets"

Crear cliente

post

Crea un cliente nuevo. (En tu doc se muestra respuesta “Client add successful.”)

Autorizaciones

authtokenstringRequerido

Cuerpo

company_namestringRequerido

addressstringOpcional

phonestringOpcional

websitestringOpcional

Respuestas

200

Client add successful

application/json

statusbooleanOpcionalExample: true

messagestringOpcionalExample: Operation successful.

post

/clients

POST /index.php/api/clients HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 72

{
  "company_name": "text",
  "address": "text",
  "phone": "text",
  "website": "text"
}

200

Client add successful

{
  "status": true,
  "message": "Operation successful."
}

Obtener cliente por ID

get

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

idintegerRequerido

Respuestas

200

Cliente

application/json

idintegerOpcionalExample: 2

company_namestringOpcionalExample: jdoe

addressstringOpcionalExample: Rajkot

created_datestring · dateOpcional

is_leadstringOpcionalExample: 0

lead_status_idstringOpcionalExample: 1

owner_idstringOpcionalExample: 1

primary_contactstringOpcionalExample: john doe

total_projectsstringOpcionalExample: 7

get

/clients/{id}

GET /index.php/api/clients/{id} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Cliente

{
  "id": 2,
  "company_name": "jdoe",
  "address": "Rajkot",
  "created_date": "2026-03-11",
  "is_lead": "0",
  "lead_status_id": "1",
  "owner_id": "1",
  "primary_contact": "john doe",
  "total_projects": "7"
}

Eliminar cliente

delete

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

idintegerRequerido

Respuestas

200

Eliminado

application/json

statusbooleanOpcionalExample: true

messagestringOpcionalExample: Operation successful.

delete

/clients/{id}

DELETE /index.php/api/clients/{id} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Eliminado

{
  "status": true,
  "message": "Operation successful."
}

Buscar clientes

get

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

keysearchstringRequerido

Respuestas

200

Coincidencias de clientes

application/json

idintegerOpcional

company_namestringOpcional

invoice_valuestringOpcional

client_groupsstringOpcional

get

/getClientsSearch/search/{keysearch}

GET /index.php/api/getClientsSearch/search/{keysearch} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Coincidencias de clientes

[
  {
    "id": 1,
    "company_name": "text",
    "invoice_value": "text",
    "client_groups": "text"
  }
]

Crear lead

post

Autorizaciones

authtokenstringRequerido

Cuerpo

company_namestringRequerido

owner_idstringRequerido

lead_status_idstringRequerido

lead_source_idstringRequerido

addressstringOpcional

citystringOpcional

statestringOpcional

zipstringOpcional

countrystringOpcional

phonestringOpcional

websitestringOpcional

vat_numberstringOpcional

Respuestas

200

Creado

application/json

statusbooleanOpcionalExample: true

messagestringOpcionalExample: Operation successful.

post

/leads

POST /index.php/api/leads HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 217

{
  "company_name": "text",
  "owner_id": "text",
  "lead_status_id": "text",
  "lead_source_id": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "country": "text",
  "phone": "text",
  "website": "text",
  "vat_number": "text"
}

200

Creado

{
  "status": true,
  "message": "Operation successful."
}

Obtener lead por ID

get

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

idintegerRequerido

Respuestas

200

Lead

application/json

idintegerOpcionalExample: 2

company_namestringOpcionalExample: Test

addressstringOpcional

citystringOpcional

statestringOpcional

zipstringOpcional

countrystringOpcional

created_datestring · dateOpcional

websitestringOpcional

phonestringOpcional

lead_status_titlestringOpcionalExample: New

owner_namestringOpcionalExample: john doe

get

/leads/{id}

GET /index.php/api/leads/{id} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Lead

{
  "id": 2,
  "company_name": "Test",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "country": "text",
  "created_date": "2026-03-11",
  "website": "text",
  "phone": "text",
  "lead_status_title": "New",
  "owner_name": "john doe"
}

Actualizar lead

put

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

idintegerRequerido

Cuerpo

Respuestas

200

Actualizado

application/json

statusbooleanOpcionalExample: true

messagestringOpcionalExample: Operation successful.

put

/leads/{id}

PUT /index.php/api/leads/{id} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 217

{
  "company_name": "text",
  "owner_id": "text",
  "lead_status_id": "text",
  "lead_source_id": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "country": "text",
  "phone": "text",
  "website": "text",
  "vat_number": "text"
}

200

Actualizado

{
  "status": true,
  "message": "Operation successful."
}

Buscar leads

get

Si tu instalación no ofrece esta ruta, usa /projects/search/{keysearch} según la nota del doc.

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

keysearchstringRequerido

Respuestas

200

Coincidencias de leads

application/json

idintegerOpcional

company_namestringOpcional

lead_status_titlestringOpcional

get

/leads/search/{keysearch}

GET /index.php/api/leads/search/{keysearch} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Coincidencias de leads

[
  {
    "id": 1,
    "company_name": "text",
    "lead_status_title": "text"
  }
]

Listar proyectos

get

Autorizaciones

authtokenstringRequerido

Respuestas

200

Proyectos

application/json

idintegerOpcionalExample: 2

titlestringOpcionalExample: project 1

descriptionstringOpcional

start_datestring · nuloOpcional

deadlinestring · nuloOpcional

client_idstringOpcionalExample: 2

statusstringOpcionalExample: open

company_namestringOpcionalExample: jdoe

currency_symbolstringOpcionalExample: INR

get

/projects/

GET /index.php/api/projects/ HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Proyectos

[
  {
    "id": 2,
    "title": "project 1",
    "description": "text",
    "start_date": "text",
    "deadline": "text",
    "client_id": "2",
    "status": "open",
    "company_name": "jdoe",
    "currency_symbol": "INR"
  }
]

Crear proyecto

post

Autorizaciones

authtokenstringRequerido

Cuerpo

titlestringRequerido

client_idstringRequerido

start_datestringRequerido

descriptionstringOpcional

Respuestas

200

Creado

application/json

statusbooleanOpcionalExample: true

messagestringOpcionalExample: Operation successful.

post

/projects

POST /index.php/api/projects HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 76

{
  "title": "text",
  "client_id": "text",
  "start_date": "text",
  "description": "text"
}

200

Creado

{
  "status": true,
  "message": "Operation successful."
}

Actualizar proyecto

put

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

idintegerRequerido

Cuerpo

Respuestas

200

Actualizado

application/json

statusbooleanOpcionalExample: true

messagestringOpcionalExample: Operation successful.

put

/projects/{id}

PUT /index.php/api/projects/{id} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 76

{
  "title": "text",
  "client_id": "text",
  "start_date": "text",
  "description": "text"
}

200

Actualizado

{
  "status": true,
  "message": "Operation successful."
}

Eliminar proyecto

delete

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

idintegerRequerido

Respuestas

200

Eliminado

application/json

statusbooleanOpcionalExample: true

messagestringOpcionalExample: Operation successful.

delete

/projects/{id}

DELETE /index.php/api/projects/{id} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Eliminado

{
  "status": true,
  "message": "Operation successful."
}

Buscar proyectos

get

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

keysearchstringRequerido

Respuestas

200

Coincidencias de proyectos

application/json

idintegerOpcional

titlestringOpcional

statusstringOpcional

get

/projects/search/{keysearch}

GET /index.php/api/projects/search/{keysearch} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Coincidencias de proyectos

[
  {
    "id": 1,
    "title": "text",
    "status": "text"
  }
]

Listar tickets

get

Autorizaciones

authtokenstringRequerido

Respuestas

200

Tickets

application/json

idintegerOpcionalExample: 1

client_idstringOpcionalExample: 2

project_idstringOpcionalExample: 0

ticket_type_idstringOpcionalExample: 1

titlestringOpcionalExample: Title

created_bystringOpcionalExample: 1

requested_bystringOpcionalExample: 4

created_atstringOpcionalExample: 2021-09-12 06:47:36

statusstringOpcionalExample: new

last_activity_atstringOpcionalExample: 2021-09-12 06:47:36

assigned_tostringOpcionalExample: 3

labelsstringOpcionalExample: 9,10

ticket_typestringOpcionalExample: General Support

company_namestringOpcionalExample: Company

assigned_to_userstringOpcionalExample: john doe

get

/tickets

GET /index.php/api/tickets HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Tickets

[
  {
    "id": 1,
    "client_id": "2",
    "project_id": "0",
    "ticket_type_id": "1",
    "title": "Title",
    "created_by": "1",
    "requested_by": "4",
    "created_at": "2021-09-12 06:47:36",
    "status": "new",
    "last_activity_at": "2021-09-12 06:47:36",
    "assigned_to": "3",
    "labels": "9,10",
    "ticket_type": "General Support",
    "company_name": "Company",
    "assigned_to_user": "john doe"
  }
]

Crear ticket

post

Autorizaciones

authtokenstringRequerido

Cuerpo

titlestringRequerido

client_idstringRequerido

requested_by_idstringRequerido

ticket_type_idstringRequerido

descriptionstringRequerido

assigned_tostringRequerido

ticket_labelsstringOpcional

Opcional (IDs separados por coma)

Respuestas

200

Creado

application/json

statusbooleanOpcionalExample: true

messagestringOpcionalExample: Operation successful.

post

/tickets

POST /index.php/api/tickets HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 149

{
  "title": "text",
  "client_id": "text",
  "requested_by_id": "text",
  "ticket_type_id": "text",
  "description": "text",
  "assigned_to": "text",
  "ticket_labels": "text"
}

200

Creado

{
  "status": true,
  "message": "Operation successful."
}

Obtener ticket por ID

get

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

idintegerRequerido

Respuestas

200

Ticket

application/json

idintegerOpcionalExample: 1

client_idstringOpcionalExample: 2

project_idstringOpcionalExample: 0

ticket_type_idstringOpcionalExample: 1

titlestringOpcionalExample: Title

created_bystringOpcionalExample: 1

requested_bystringOpcionalExample: 4

created_atstringOpcionalExample: 2021-09-12 06:47:36

statusstringOpcionalExample: new

last_activity_atstringOpcionalExample: 2021-09-12 06:47:36

assigned_tostringOpcionalExample: 3

labelsstringOpcionalExample: 9,10

ticket_typestringOpcionalExample: General Support

company_namestringOpcionalExample: Company

assigned_to_userstringOpcionalExample: john doe

get

/tickets/{id}

GET /index.php/api/tickets/{id} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Ticket

{
  "id": 1,
  "client_id": "2",
  "project_id": "0",
  "ticket_type_id": "1",
  "title": "Title",
  "created_by": "1",
  "requested_by": "4",
  "created_at": "2021-09-12 06:47:36",
  "status": "new",
  "last_activity_at": "2021-09-12 06:47:36",
  "assigned_to": "3",
  "labels": "9,10",
  "ticket_type": "General Support",
  "company_name": "Company",
  "assigned_to_user": "john doe"
}

Actualizar ticket

put

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

idintegerRequerido

Cuerpo

Respuestas

200

Actualizado

application/json

statusbooleanOpcionalExample: true

messagestringOpcionalExample: Operation successful.

put

/tickets/{id}

PUT /index.php/api/tickets/{id} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 149

{
  "title": "text",
  "client_id": "text",
  "requested_by_id": "text",
  "ticket_type_id": "text",
  "description": "text",
  "assigned_to": "text",
  "ticket_labels": "text"
}

200

Actualizado

{
  "status": true,
  "message": "Operation successful."
}

Eliminar ticket

delete

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

idintegerRequerido

Respuestas

200

Eliminado

application/json

statusbooleanOpcionalExample: true

messagestringOpcionalExample: Operation successful.

delete

/tickets/{id}

DELETE /index.php/api/tickets/{id} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Eliminado

{
  "status": true,
  "message": "Operation successful."
}

Buscar tickets

get

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

keysearchstringRequerido

Respuestas

200

Coincidencias de tickets

application/json

idintegerOpcional

titlestringOpcional

statusstringOpcional

get

/tickets/search/{keysearch}

GET /index.php/api/tickets/search/{keysearch} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Coincidencias de tickets

[
  {
    "id": 1,
    "title": "text",
    "status": "text"
  }
]

Crear factura

post

Autorizaciones

authtokenstringRequerido

Cuerpo

invoice_due_datestringRequerido

invoice_client_idstringRequerido

invoice_bill_datestringOpcional

invoice_project_idstringOpcional

tax_idstringOpcional

tax_id2stringOpcional

tax_id3stringOpcional

recurringstringOpcional

invoice_notestringOpcional

Respuestas

200

Creado

application/json

statusbooleanOpcionalExample: true

messagestringOpcionalExample: Operation successful.

post

/invoices

POST /index.php/api/invoices HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 200

{
  "invoice_due_date": "text",
  "invoice_client_id": "text",
  "invoice_bill_date": "text",
  "invoice_project_id": "text",
  "tax_id": "text",
  "tax_id2": "text",
  "tax_id3": "text",
  "recurring": "text",
  "invoice_note": "text"
}

200

Creado

{
  "status": true,
  "message": "Operation successful."
}

Buscar facturas

get

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

keysearchstringRequerido

Respuestas

200

Coincidencias de facturas

application/json

idintegerOpcional

client_idstringOpcional

statusstringOpcional

get

/invoices/search/{keysearch}

GET /index.php/api/invoices/search/{keysearch} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Coincidencias de facturas

[
  {
    "id": 1,
    "client_id": "text",
    "status": "text"
  }
]

Listar grupos de clientes

get

Autorizaciones

authtokenstringRequerido

Respuestas

200

Grupos de clientes

application/json

idstringOpcionalExample: 1

titlestringOpcionalExample: Test c group

deletedstringOpcionalExample: 0

get

/client_groups

GET /index.php/api/client_groups HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Grupos de clientes

[
  {
    "id": "1",
    "title": "Test c group",
    "deleted": "0"
  }
]

Listar etiquetas de facturas

get

Autorizaciones

authtokenstringRequerido

Respuestas

200

Etiquetas de factura

application/json

idstringOpcional

titlestringOpcional

colorstringOpcional

contextstringOpcional

deletedstringOpcional

get

/invoice_labels

GET /index.php/api/invoice_labels HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Etiquetas de factura

[
  {
    "id": "text",
    "title": "text",
    "color": "text",
    "context": "text",
    "deleted": "text"
  }
]

Listar impuestos de factura

get

Autorizaciones

authtokenstringRequerido

Respuestas

200

Impuestos configurados

application/json

idstringOpcionalExample: 1

titlestringOpcionalExample: Tax (10%)

percentagestringOpcionalExample: 10

deletedstringOpcionalExample: 0

get

/invoice_tax

GET /index.php/api/invoice_tax HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Impuestos configurados

[
  {
    "id": "1",
    "title": "Tax (10%)",
    "percentage": "10",
    "deleted": "0"
  }
]

Listar etiquetas de proyecto

get

Autorizaciones

authtokenstringRequerido

Respuestas

200

Etiquetas de proyecto

application/json

idstringOpcional

titlestringOpcional

colorstringOpcional

contextstringOpcional

deletedstringOpcional

get

/project_labels

GET /index.php/api/project_labels HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Etiquetas de proyecto

[
  {
    "id": "text",
    "title": "text",
    "color": "text",
    "context": "text",
    "deleted": "text"
  }
]

Listar miembros de proyecto

get

Autorizaciones

authtokenstringRequerido

Respuestas

200

Miembros de proyecto

application/json

idstringOpcionalExample: 6

user_idstringOpcionalExample: 1

project_idstringOpcionalExample: 1

is_leaderstringOpcionalExample: 1

member_namestringOpcionalExample: Fname Lname

user_typestringOpcionalExample: staff

get

/getProjectMembers

GET /index.php/api/getProjectMembers HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Miembros de proyecto

[
  {
    "id": "6",
    "user_id": "1",
    "project_id": "1",
    "is_leader": "1",
    "member_name": "Fname Lname",
    "user_type": "staff"
  }
]

Listar contactos por ClientID

get

Autorizaciones

authtokenstringRequerido

Parámetros de ruta

clientidintegerRequerido

Respuestas

200

Contactos del cliente

application/json

idstringOpcionalExample: 6

first_namestringOpcionalExample: Fname

last_namestringOpcionalExample: Lname

user_typestringOpcionalExample: client

statusstringOpcionalExample: active

client_idstringOpcionalExample: 3

get

/contact_by_clientid/{clientid}

GET /index.php/api/contact_by_clientid/{clientid} HTTP/1.1
Host: crm.myscreators.com
authtoken: YOUR_API_KEY
Accept: */*

200

Contactos del cliente

[
  {
    "id": "6",
    "first_name": "Fname",
    "last_name": "Lname",
    "user_type": "client",
    "status": "active",
    "client_id": "3"
  }
]

Última actualización hace 6 meses

Buenos días

hashtagIntroducción

hashtagAutenticación

hashtagEjemplo de uso

hashtagCrear cliente

hashtagObtener cliente por ID

hashtagEliminar cliente

hashtagBuscar clientes

hashtagCrear lead

hashtagObtener lead por ID

hashtagActualizar lead

hashtagBuscar leads

hashtagListar proyectos

hashtagCrear proyecto

hashtagActualizar proyecto

hashtagEliminar proyecto

hashtagBuscar proyectos

hashtagListar tickets

hashtagCrear ticket

hashtagObtener ticket por ID

hashtagActualizar ticket

hashtagEliminar ticket

hashtagBuscar tickets

hashtagCrear factura

hashtagBuscar facturas

hashtagListar grupos de clientes

hashtagListar etiquetas de facturas

hashtagListar impuestos de factura

hashtagListar etiquetas de proyecto

hashtagListar miembros de proyecto

hashtagListar contactos por ClientID

Introducción

Autenticación

Ejemplo de uso

Crear cliente

Obtener cliente por ID

Eliminar cliente

Buscar clientes

Crear lead

Obtener lead por ID

Actualizar lead

Buscar leads

Listar proyectos

Crear proyecto

Actualizar proyecto

Eliminar proyecto

Buscar proyectos

Listar tickets

Crear ticket

Obtener ticket por ID

Actualizar ticket

Eliminar ticket

Buscar tickets

Crear factura

Buscar facturas

Listar grupos de clientes

Listar etiquetas de facturas

Listar impuestos de factura

Listar etiquetas de proyecto

Listar miembros de proyecto

Listar contactos por ClientID