> For the complete documentation index, see [llms.txt](https://developers.myscreators.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.myscreators.com/readme.md).

# REST API para M\&S CRM

## 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.

{% hint style="info" %}
**Header:** `authtoken: TU_TOKEN`
{% endhint %}

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

{% hint style="warning" %}
**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.
{% endhint %}

## Ejemplo de uso

**Escenario:** Con token `jEheVytlAoFl7F8MqUQ7jAo2hOXAS`, listar tickets:

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

## Crear cliente

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

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Clients"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"ClientCreate":{"type":"object","required":["company_name"],"properties":{"company_name":{"type":"string"},"address":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"}}},"ApiMessage":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"}}}}},"paths":{"/clients":{"post":{"tags":["Clients"],"summary":"Crear cliente","description":"Crea un cliente nuevo. (En tu doc se muestra respuesta “Client add successful.”)","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ClientCreate"}}}},"responses":{"200":{"description":"Client add successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}}}}}
```

## GET /clients/{id}

> Obtener cliente por ID

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Clients"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"Client":{"type":"object","properties":{"id":{"type":"integer"},"company_name":{"type":"string"},"address":{"type":"string"},"created_date":{"type":"string","format":"date"},"is_lead":{"type":"string"},"lead_status_id":{"type":"string"},"owner_id":{"type":"string"},"primary_contact":{"type":"string"},"total_projects":{"type":"string"}}}}},"paths":{"/clients/{id}":{"get":{"tags":["Clients"],"summary":"Obtener cliente por ID","responses":{"200":{"description":"Cliente","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client"}}}}}}}}}
```

## DELETE /clients/{id}

> Eliminar cliente

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Clients"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"ApiMessage":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"}}}}},"paths":{"/clients/{id}":{"delete":{"tags":["Clients"],"summary":"Eliminar cliente","responses":{"200":{"description":"Eliminado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}}}}}
```

## GET /getClientsSearch/search/{keysearch}

> Buscar clientes

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Clients"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"ClientSearchItem":{"type":"object","properties":{"id":{"type":"integer"},"company_name":{"type":"string"},"invoice_value":{"type":"string"},"client_groups":{"type":"string"}}}}},"paths":{"/getClientsSearch/search/{keysearch}":{"get":{"tags":["Clients"],"summary":"Buscar clientes","parameters":[{"in":"path","name":"keysearch","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Coincidencias de clientes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClientSearchItem"}}}}}}}}}}
```

## POST /leads

> Crear lead

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Leads"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"LeadCreate":{"type":"object","required":["company_name","owner_id","lead_status_id","lead_source_id"],"properties":{"company_name":{"type":"string"},"owner_id":{"type":"string"},"lead_status_id":{"type":"string"},"lead_source_id":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"},"vat_number":{"type":"string"}}},"ApiMessage":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"}}}}},"paths":{"/leads":{"post":{"tags":["Leads"],"summary":"Crear lead","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/LeadCreate"}}}},"responses":{"200":{"description":"Creado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}}}}}
```

## GET /leads/{id}

> Obtener lead por ID

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Leads"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"Lead":{"type":"object","properties":{"id":{"type":"integer"},"company_name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"created_date":{"type":"string","format":"date"},"website":{"type":"string"},"phone":{"type":"string"},"lead_status_title":{"type":"string"},"owner_name":{"type":"string"}}}}},"paths":{"/leads/{id}":{"get":{"tags":["Leads"],"summary":"Obtener lead por ID","responses":{"200":{"description":"Lead","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lead"}}}}}}}}}
```

## PUT /leads/{id}

> Actualizar lead

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Leads"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"LeadUpdate":{"allOf":[{"$ref":"#/components/schemas/LeadCreate"}]},"LeadCreate":{"type":"object","required":["company_name","owner_id","lead_status_id","lead_source_id"],"properties":{"company_name":{"type":"string"},"owner_id":{"type":"string"},"lead_status_id":{"type":"string"},"lead_source_id":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"},"vat_number":{"type":"string"}}},"ApiMessage":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"}}}}},"paths":{"/leads/{id}":{"put":{"tags":["Leads"],"summary":"Actualizar lead","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/LeadUpdate"}}}},"responses":{"200":{"description":"Actualizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}}}}}
```

## Buscar leads

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

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Leads"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"LeadSearchItem":{"type":"object","properties":{"id":{"type":"integer"},"company_name":{"type":"string"},"lead_status_title":{"type":"string"}}}}},"paths":{"/leads/search/{keysearch}":{"get":{"tags":["Leads"],"summary":"Buscar leads","description":"Si tu instalación no ofrece esta ruta, usa `/projects/search/{keysearch}` según la nota del doc.","parameters":[{"in":"path","name":"keysearch","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Coincidencias de leads","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LeadSearchItem"}}}}}}}}}}
```

## GET /projects/

> Listar proyectos

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Projects"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"Project":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"description":{"type":"string"},"start_date":{"type":"string","nullable":true},"deadline":{"type":"string","nullable":true},"client_id":{"type":"string"},"status":{"type":"string"},"company_name":{"type":"string"},"currency_symbol":{"type":"string"}}}}},"paths":{"/projects/":{"get":{"tags":["Projects"],"summary":"Listar proyectos","responses":{"200":{"description":"Proyectos","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Project"}}}}}}}}}}
```

## POST /projects

> Crear proyecto

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Projects"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"ProjectCreate":{"type":"object","required":["title","client_id","start_date"],"properties":{"title":{"type":"string"},"client_id":{"type":"string"},"start_date":{"type":"string"},"description":{"type":"string"}}},"ApiMessage":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"}}}}},"paths":{"/projects":{"post":{"tags":["Projects"],"summary":"Crear proyecto","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ProjectCreate"}}}},"responses":{"200":{"description":"Creado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}}}}}
```

## PUT /projects/{id}

> Actualizar proyecto

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Projects"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"ProjectUpdate":{"allOf":[{"$ref":"#/components/schemas/ProjectCreate"}]},"ProjectCreate":{"type":"object","required":["title","client_id","start_date"],"properties":{"title":{"type":"string"},"client_id":{"type":"string"},"start_date":{"type":"string"},"description":{"type":"string"}}},"ApiMessage":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"}}}}},"paths":{"/projects/{id}":{"put":{"tags":["Projects"],"summary":"Actualizar proyecto","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ProjectUpdate"}}}},"responses":{"200":{"description":"Actualizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}}}}}
```

## DELETE /projects/{id}

> Eliminar proyecto

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Projects"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"ApiMessage":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"}}}}},"paths":{"/projects/{id}":{"delete":{"tags":["Projects"],"summary":"Eliminar proyecto","responses":{"200":{"description":"Eliminado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}}}}}
```

## GET /projects/search/{keysearch}

> Buscar proyectos

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Projects"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"ProjectSearchItem":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"status":{"type":"string"}}}}},"paths":{"/projects/search/{keysearch}":{"get":{"tags":["Projects"],"summary":"Buscar proyectos","parameters":[{"in":"path","name":"keysearch","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Coincidencias de proyectos","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectSearchItem"}}}}}}}}}}
```

## GET /tickets

> Listar tickets

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Tickets"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"Ticket":{"type":"object","properties":{"id":{"type":"integer"},"client_id":{"type":"string"},"project_id":{"type":"string"},"ticket_type_id":{"type":"string"},"title":{"type":"string"},"created_by":{"type":"string"},"requested_by":{"type":"string"},"created_at":{"type":"string"},"status":{"type":"string"},"last_activity_at":{"type":"string"},"assigned_to":{"type":"string"},"labels":{"type":"string"},"ticket_type":{"type":"string"},"company_name":{"type":"string"},"assigned_to_user":{"type":"string"}}}}},"paths":{"/tickets":{"get":{"tags":["Tickets"],"summary":"Listar tickets","responses":{"200":{"description":"Tickets","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Ticket"}}}}}}}}}}
```

## POST /tickets

> Crear ticket

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Tickets"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"TicketCreate":{"type":"object","required":["title","client_id","requested_by_id","ticket_type_id","description","assigned_to"],"properties":{"title":{"type":"string"},"client_id":{"type":"string"},"requested_by_id":{"type":"string"},"ticket_type_id":{"type":"string"},"description":{"type":"string"},"assigned_to":{"type":"string"},"ticket_labels":{"type":"string","description":"Opcional (IDs separados por coma)"}}},"ApiMessage":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"}}}}},"paths":{"/tickets":{"post":{"tags":["Tickets"],"summary":"Crear ticket","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/TicketCreate"}}}},"responses":{"200":{"description":"Creado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}}}}}
```

## GET /tickets/{id}

> Obtener ticket por ID

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Tickets"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"Ticket":{"type":"object","properties":{"id":{"type":"integer"},"client_id":{"type":"string"},"project_id":{"type":"string"},"ticket_type_id":{"type":"string"},"title":{"type":"string"},"created_by":{"type":"string"},"requested_by":{"type":"string"},"created_at":{"type":"string"},"status":{"type":"string"},"last_activity_at":{"type":"string"},"assigned_to":{"type":"string"},"labels":{"type":"string"},"ticket_type":{"type":"string"},"company_name":{"type":"string"},"assigned_to_user":{"type":"string"}}}}},"paths":{"/tickets/{id}":{"get":{"tags":["Tickets"],"summary":"Obtener ticket por ID","responses":{"200":{"description":"Ticket","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ticket"}}}}}}}}}
```

## PUT /tickets/{id}

> Actualizar ticket

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Tickets"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"TicketUpdate":{"allOf":[{"$ref":"#/components/schemas/TicketCreate"}]},"TicketCreate":{"type":"object","required":["title","client_id","requested_by_id","ticket_type_id","description","assigned_to"],"properties":{"title":{"type":"string"},"client_id":{"type":"string"},"requested_by_id":{"type":"string"},"ticket_type_id":{"type":"string"},"description":{"type":"string"},"assigned_to":{"type":"string"},"ticket_labels":{"type":"string","description":"Opcional (IDs separados por coma)"}}},"ApiMessage":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"}}}}},"paths":{"/tickets/{id}":{"put":{"tags":["Tickets"],"summary":"Actualizar ticket","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/TicketUpdate"}}}},"responses":{"200":{"description":"Actualizado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}}}}}
```

## DELETE /tickets/{id}

> Eliminar ticket

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Tickets"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"ApiMessage":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"}}}}},"paths":{"/tickets/{id}":{"delete":{"tags":["Tickets"],"summary":"Eliminar ticket","responses":{"200":{"description":"Eliminado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}}}}}
```

## GET /tickets/search/{keysearch}

> Buscar tickets

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Tickets"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"TicketSearchItem":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"status":{"type":"string"}}}}},"paths":{"/tickets/search/{keysearch}":{"get":{"tags":["Tickets"],"summary":"Buscar tickets","parameters":[{"in":"path","name":"keysearch","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Coincidencias de tickets","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TicketSearchItem"}}}}}}}}}}
```

## POST /invoices

> Crear factura

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Invoices"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"InvoiceCreate":{"type":"object","required":["invoice_due_date","invoice_client_id"],"properties":{"invoice_due_date":{"type":"string"},"invoice_client_id":{"type":"string"},"invoice_bill_date":{"type":"string"},"invoice_project_id":{"type":"string"},"tax_id":{"type":"string"},"tax_id2":{"type":"string"},"tax_id3":{"type":"string"},"recurring":{"type":"string"},"invoice_note":{"type":"string"}}},"ApiMessage":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"}}}}},"paths":{"/invoices":{"post":{"tags":["Invoices"],"summary":"Crear factura","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/InvoiceCreate"}}}},"responses":{"200":{"description":"Creado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMessage"}}}}}}}}}
```

## GET /invoices/search/{keysearch}

> Buscar facturas

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Invoices"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"InvoiceSearchItem":{"type":"object","properties":{"id":{"type":"integer"},"client_id":{"type":"string"},"status":{"type":"string"}}}}},"paths":{"/invoices/search/{keysearch}":{"get":{"tags":["Invoices"],"summary":"Buscar facturas","parameters":[{"in":"path","name":"keysearch","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Coincidencias de facturas","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceSearchItem"}}}}}}}}}}
```

## GET /client\_groups

> Listar grupos de clientes

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Helpers"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"ClientGroup":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"deleted":{"type":"string"}}}}},"paths":{"/client_groups":{"get":{"tags":["Helpers"],"summary":"Listar grupos de clientes","responses":{"200":{"description":"Grupos de clientes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClientGroup"}}}}}}}}}}
```

## GET /invoice\_labels

> Listar etiquetas de facturas

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Helpers"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"Label":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"color":{"type":"string"},"context":{"type":"string"},"deleted":{"type":"string"}}}}},"paths":{"/invoice_labels":{"get":{"tags":["Helpers"],"summary":"Listar etiquetas de facturas","responses":{"200":{"description":"Etiquetas de factura","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Label"}}}}}}}}}}
```

## GET /invoice\_tax

> Listar impuestos de factura

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Helpers"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"InvoiceTax":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"percentage":{"type":"string"},"deleted":{"type":"string"}}}}},"paths":{"/invoice_tax":{"get":{"tags":["Helpers"],"summary":"Listar impuestos de factura","responses":{"200":{"description":"Impuestos configurados","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceTax"}}}}}}}}}}
```

## GET /project\_labels

> Listar etiquetas de proyecto

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Helpers"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"Label":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"color":{"type":"string"},"context":{"type":"string"},"deleted":{"type":"string"}}}}},"paths":{"/project_labels":{"get":{"tags":["Helpers"],"summary":"Listar etiquetas de proyecto","responses":{"200":{"description":"Etiquetas de proyecto","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Label"}}}}}}}}}}
```

## GET /getProjectMembers

> Listar miembros de proyecto

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Helpers"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"ProjectMember":{"type":"object","properties":{"id":{"type":"string"},"user_id":{"type":"string"},"project_id":{"type":"string"},"is_leader":{"type":"string"},"member_name":{"type":"string"},"user_type":{"type":"string"}}}}},"paths":{"/getProjectMembers":{"get":{"tags":["Helpers"],"summary":"Listar miembros de proyecto","responses":{"200":{"description":"Miembros de proyecto","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectMember"}}}}}}}}}}
```

## GET /contact\_by\_clientid/{clientid}

> Listar contactos por ClientID

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"tags":[{"name":"Helpers"}],"servers":[{"url":"https://crm.myscreators.com/index.php/api","description":"Producción"}],"security":[{"ApiToken":[]}],"components":{"securitySchemes":{"ApiToken":{"type":"apiKey","in":"header","name":"authtoken"}},"schemas":{"Contact":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"user_type":{"type":"string"},"status":{"type":"string"},"client_id":{"type":"string"}}}}},"paths":{"/contact_by_clientid/{clientid}":{"get":{"tags":["Helpers"],"summary":"Listar contactos por ClientID","parameters":[{"in":"path","name":"clientid","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Contactos del cliente","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}}}}}}}}}}
```

## The ApiMessage object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"ApiMessage":{"type":"object","properties":{"status":{"type":"boolean"},"message":{"type":"string"}}}}}}
```

## The Client object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"Client":{"type":"object","properties":{"id":{"type":"integer"},"company_name":{"type":"string"},"address":{"type":"string"},"created_date":{"type":"string","format":"date"},"is_lead":{"type":"string"},"lead_status_id":{"type":"string"},"owner_id":{"type":"string"},"primary_contact":{"type":"string"},"total_projects":{"type":"string"}}}}}}
```

## The ClientCreate object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"ClientCreate":{"type":"object","required":["company_name"],"properties":{"company_name":{"type":"string"},"address":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"}}}}}}
```

## The ClientSearchItem object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"ClientSearchItem":{"type":"object","properties":{"id":{"type":"integer"},"company_name":{"type":"string"},"invoice_value":{"type":"string"},"client_groups":{"type":"string"}}}}}}
```

## The Lead object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"Lead":{"type":"object","properties":{"id":{"type":"integer"},"company_name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"created_date":{"type":"string","format":"date"},"website":{"type":"string"},"phone":{"type":"string"},"lead_status_title":{"type":"string"},"owner_name":{"type":"string"}}}}}}
```

## The LeadCreate object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"LeadCreate":{"type":"object","required":["company_name","owner_id","lead_status_id","lead_source_id"],"properties":{"company_name":{"type":"string"},"owner_id":{"type":"string"},"lead_status_id":{"type":"string"},"lead_source_id":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"},"vat_number":{"type":"string"}}}}}}
```

## The LeadUpdate object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"LeadUpdate":{"allOf":[{"$ref":"#/components/schemas/LeadCreate"}]},"LeadCreate":{"type":"object","required":["company_name","owner_id","lead_status_id","lead_source_id"],"properties":{"company_name":{"type":"string"},"owner_id":{"type":"string"},"lead_status_id":{"type":"string"},"lead_source_id":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"},"vat_number":{"type":"string"}}}}}}
```

## The LeadSearchItem object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"LeadSearchItem":{"type":"object","properties":{"id":{"type":"integer"},"company_name":{"type":"string"},"lead_status_title":{"type":"string"}}}}}}
```

## The TicketCreate object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"TicketCreate":{"type":"object","required":["title","client_id","requested_by_id","ticket_type_id","description","assigned_to"],"properties":{"title":{"type":"string"},"client_id":{"type":"string"},"requested_by_id":{"type":"string"},"ticket_type_id":{"type":"string"},"description":{"type":"string"},"assigned_to":{"type":"string"},"ticket_labels":{"type":"string","description":"Opcional (IDs separados por coma)"}}}}}}
```

## The Ticket object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"Ticket":{"type":"object","properties":{"id":{"type":"integer"},"client_id":{"type":"string"},"project_id":{"type":"string"},"ticket_type_id":{"type":"string"},"title":{"type":"string"},"created_by":{"type":"string"},"requested_by":{"type":"string"},"created_at":{"type":"string"},"status":{"type":"string"},"last_activity_at":{"type":"string"},"assigned_to":{"type":"string"},"labels":{"type":"string"},"ticket_type":{"type":"string"},"company_name":{"type":"string"},"assigned_to_user":{"type":"string"}}}}}}
```

## The ProjectSearchItem object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"ProjectSearchItem":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"status":{"type":"string"}}}}}}
```

## The ProjectUpdate object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"ProjectUpdate":{"allOf":[{"$ref":"#/components/schemas/ProjectCreate"}]},"ProjectCreate":{"type":"object","required":["title","client_id","start_date"],"properties":{"title":{"type":"string"},"client_id":{"type":"string"},"start_date":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The ProjectCreate object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"ProjectCreate":{"type":"object","required":["title","client_id","start_date"],"properties":{"title":{"type":"string"},"client_id":{"type":"string"},"start_date":{"type":"string"},"description":{"type":"string"}}}}}}
```

## The Project object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"Project":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"description":{"type":"string"},"start_date":{"type":"string","nullable":true},"deadline":{"type":"string","nullable":true},"client_id":{"type":"string"},"status":{"type":"string"},"company_name":{"type":"string"},"currency_symbol":{"type":"string"}}}}}}
```

## The TicketUpdate object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"TicketUpdate":{"allOf":[{"$ref":"#/components/schemas/TicketCreate"}]},"TicketCreate":{"type":"object","required":["title","client_id","requested_by_id","ticket_type_id","description","assigned_to"],"properties":{"title":{"type":"string"},"client_id":{"type":"string"},"requested_by_id":{"type":"string"},"ticket_type_id":{"type":"string"},"description":{"type":"string"},"assigned_to":{"type":"string"},"ticket_labels":{"type":"string","description":"Opcional (IDs separados por coma)"}}}}}}
```

## The TicketSearchItem object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"TicketSearchItem":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"status":{"type":"string"}}}}}}
```

## The InvoiceCreate object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"InvoiceCreate":{"type":"object","required":["invoice_due_date","invoice_client_id"],"properties":{"invoice_due_date":{"type":"string"},"invoice_client_id":{"type":"string"},"invoice_bill_date":{"type":"string"},"invoice_project_id":{"type":"string"},"tax_id":{"type":"string"},"tax_id2":{"type":"string"},"tax_id3":{"type":"string"},"recurring":{"type":"string"},"invoice_note":{"type":"string"}}}}}}
```

## The InvoiceSearchItem object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"InvoiceSearchItem":{"type":"object","properties":{"id":{"type":"integer"},"client_id":{"type":"string"},"status":{"type":"string"}}}}}}
```

## The ClientGroup object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"ClientGroup":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"deleted":{"type":"string"}}}}}}
```

## The Label object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"Label":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"color":{"type":"string"},"context":{"type":"string"},"deleted":{"type":"string"}}}}}}
```

## The InvoiceTax object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"InvoiceTax":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"percentage":{"type":"string"},"deleted":{"type":"string"}}}}}}
```

## The ProjectMember object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"ProjectMember":{"type":"object","properties":{"id":{"type":"string"},"user_id":{"type":"string"},"project_id":{"type":"string"},"is_leader":{"type":"string"},"member_name":{"type":"string"},"user_type":{"type":"string"}}}}}}
```

## The Contact object

```json
{"openapi":"3.0.3","info":{"title":"M&S Creators — CRM API","version":"1.1.2"},"components":{"schemas":{"Contact":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"user_type":{"type":"string"},"status":{"type":"string"},"client_id":{"type":"string"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.myscreators.com/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.