{"openapi":"3.1.0","info":{"title":"ProCrmPy API","description":"Prospecção sobre base RF (registro puro) + CRM","version":"0.1.0"},"paths":{"/api/v1/rf/meta":{"get":{"tags":["Receita Federal"],"summary":"Rf Meta","description":"Metadados para filtros e formulários de prospecção.","operationId":"rf_meta_api_v1_rf_meta_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/rf/ufs":{"get":{"tags":["Receita Federal"],"summary":"List Ufs","operationId":"list_ufs_api_v1_rf_ufs_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/rf/municipios":{"get":{"tags":["Receita Federal"],"summary":"List Municipios","operationId":"list_municipios_api_v1_rf_municipios_get","parameters":[{"name":"uf","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uf"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Q"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":20,"title":"Limit"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/rf/estabelecimentos/{cnpj}":{"get":{"tags":["Receita Federal"],"summary":"Get Estabelecimento","description":"Ficha RF montada pelo assembler (somente leitura em rf.*).","operationId":"get_estabelecimento_api_v1_rf_estabelecimentos__cnpj__get","parameters":[{"name":"cnpj","in":"path","required":true,"schema":{"type":"string","title":"Cnpj"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/rf/estabelecimentos/{cnpj}/socios":{"get":{"tags":["Receita Federal"],"summary":"List Socios","operationId":"list_socios_api_v1_rf_estabelecimentos__cnpj__socios_get","parameters":[{"name":"cnpj","in":"path","required":true,"schema":{"type":"string","title":"Cnpj"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/rf/cnaes":{"get":{"tags":["Receita Federal"],"summary":"List Cnaes","description":"CNAEs distintos do mercado (com descrição RF), opcionalmente filtrados por UF.","operationId":"list_cnaes_api_v1_rf_cnaes_get","parameters":[{"name":"mercado","in":"query","required":true,"schema":{"type":"string","description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos","title":"Mercado"},"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos"},{"name":"uf","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uf"}},{"name":"situacao","in":"query","required":false,"schema":{"type":"string","description":"Situação cadastral","default":"02","title":"Situacao"},"description":"Situação cadastral"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/rf/search":{"get":{"tags":["Receita Federal"],"summary":"Search Estabelecimentos","operationId":"search_estabelecimentos_api_v1_rf_search_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CNPJ, razão social ou nome fantasia","title":"Q"},"description":"CNPJ, razão social ou nome fantasia"},{"name":"uf","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uf"}},{"name":"municipio","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Código IBGE do município (ou nome, resolvido no backend)","title":"Municipio"},"description":"Código IBGE do município (ou nome, resolvido no backend)"},{"name":"cnae","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"CNAE(s) principal — repetir o parâmetro para múltiplos","title":"Cnae"},"description":"CNAE(s) principal — repetir o parâmetro para múltiplos"},{"name":"situacao","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Situacao"}},{"name":"segmento","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Segmento(s) de ensino — repetir o parâmetro para múltiplos","title":"Segmento"},"description":"Segmento(s) de ensino — repetir o parâmetro para múltiplos"},{"name":"porte","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Porte"}},{"name":"prospect_status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ProspectStatus"},{"type":"null"}],"title":"Prospect Status"}},{"name":"contact_filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"visit_only | no_mobile_no_email | no_email | landline_only | email_only | has_whatsapp","title":"Contact Filter"},"description":"visit_only | no_mobile_no_email | no_email | landline_only | email_only | has_whatsapp"},{"name":"socio","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nome do sócio","title":"Socio"},"description":"Nome do sócio"},{"name":"telefone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Telefone(s) parcial(is), separados por vírgula","title":"Telefone"},"description":"Telefone(s) parcial(is), separados por vírgula"},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"E-mail (parcial)","title":"Email"},"description":"E-mail (parcial)"},{"name":"interacao_filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"interesse | sem_interesse | follow_up","title":"Interacao Filter"},"description":"interesse | sem_interesse | follow_up"},{"name":"mercado","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos","title":"Mercado"},"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"enum":["razao_social","municipio","cnae","segmento","porte","socio_faixa","socio_nome","contato","status_interacao"],"type":"string"},{"type":"null"}],"title":"Sort By"}},{"name":"sort_dir","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","default":"asc","title":"Sort Dir"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":20,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"include_total","in":"query","required":false,"schema":{"type":"boolean","description":"Se false, retorna só a página (total omitido).","default":true,"title":"Include Total"},"description":"Se false, retorna só a página (total omitido)."},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/rf/search/count":{"get":{"tags":["Receita Federal"],"summary":"Count Estabelecimentos","operationId":"count_estabelecimentos_api_v1_rf_search_count_get","parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CNPJ, razão social ou nome fantasia","title":"Q"},"description":"CNPJ, razão social ou nome fantasia"},{"name":"uf","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uf"}},{"name":"municipio","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Código IBGE do município (ou nome, resolvido no backend)","title":"Municipio"},"description":"Código IBGE do município (ou nome, resolvido no backend)"},{"name":"cnae","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"CNAE(s) principal — repetir o parâmetro para múltiplos","title":"Cnae"},"description":"CNAE(s) principal — repetir o parâmetro para múltiplos"},{"name":"situacao","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Situacao"}},{"name":"segmento","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Segmento(s) de ensino — repetir o parâmetro para múltiplos","title":"Segmento"},"description":"Segmento(s) de ensino — repetir o parâmetro para múltiplos"},{"name":"porte","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Porte"}},{"name":"prospect_status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ProspectStatus"},{"type":"null"}],"title":"Prospect Status"}},{"name":"contact_filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"visit_only | no_mobile_no_email | no_email | landline_only | email_only | has_whatsapp","title":"Contact Filter"},"description":"visit_only | no_mobile_no_email | no_email | landline_only | email_only | has_whatsapp"},{"name":"socio","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Nome do sócio","title":"Socio"},"description":"Nome do sócio"},{"name":"telefone","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Telefone(s) parcial(is), separados por vírgula","title":"Telefone"},"description":"Telefone(s) parcial(is), separados por vírgula"},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"E-mail (parcial)","title":"Email"},"description":"E-mail (parcial)"},{"name":"interacao_filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"interesse | sem_interesse | follow_up","title":"Interacao Filter"},"description":"interesse | sem_interesse | follow_up"},{"name":"mercado","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos","title":"Mercado"},"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prospects":{"post":{"tags":["CRM"],"summary":"Create Prospect","operationId":"create_prospect_api_v1_prospects_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProspectCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProspectOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["CRM"],"summary":"List Prospects","operationId":"list_prospects_api_v1_prospects_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ProspectStatus"},{"type":"null"}],"title":"Status"}},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"enum":["status","contato_nome","contato_papel","razao_social","nome_fantasia","segmento","porte","socio_faixa","demonstrou_interesse","teve_follow_up"],"type":"string"},{"type":"null"}],"title":"Sort By"}},{"name":"sort_dir","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","default":"asc","title":"Sort Dir"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"mercado","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos | prospeccao_rh | outros | todos","title":"Mercado"},"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos | prospeccao_rh | outros | todos"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProspectListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prospects/{prospect_id}":{"get":{"tags":["CRM"],"summary":"Get Prospect","operationId":"get_prospect_api_v1_prospects__prospect_id__get","parameters":[{"name":"prospect_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Prospect Id"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProspectOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prospects/{prospect_id}/timeline":{"get":{"tags":["CRM"],"summary":"Timeline","operationId":"timeline_api_v1_prospects__prospect_id__timeline_get","parameters":[{"name":"prospect_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Prospect Id"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InteractionOut"},"title":"Response Timeline Api V1 Prospects  Prospect Id  Timeline Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prospects/{prospect_id}/interactions":{"post":{"tags":["CRM"],"summary":"Create Interaction","operationId":"create_interaction_api_v1_prospects__prospect_id__interactions_post","parameters":[{"name":"prospect_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Prospect Id"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InteractionCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InteractionOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prospects/{prospect_id}/interactions/{interaction_id}":{"patch":{"tags":["CRM"],"summary":"Update Interaction","operationId":"update_interaction_api_v1_prospects__prospect_id__interactions__interaction_id__patch","parameters":[{"name":"prospect_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Prospect Id"}},{"name":"interaction_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Interaction Id"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InteractionUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InteractionOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["CRM"],"summary":"Delete Interaction","operationId":"delete_interaction_api_v1_prospects__prospect_id__interactions__interaction_id__delete","parameters":[{"name":"prospect_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Prospect Id"}},{"name":"interaction_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Interaction Id"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/interactions/bulk":{"post":{"tags":["CRM"],"summary":"Bulk Create Interactions","operationId":"bulk_create_interactions_api_v1_interactions_bulk_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkInteractionCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkInteractionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prospects/{prospect_id}/contacts":{"post":{"tags":["CRM"],"summary":"Add Contact","operationId":"add_contact_api_v1_prospects__prospect_id__contacts_post","parameters":[{"name":"prospect_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Prospect Id"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prospects/{prospect_id}/consent":{"post":{"tags":["CRM"],"summary":"Grant Consent","operationId":"grant_consent_api_v1_prospects__prospect_id__consent_post","parameters":[{"name":"prospect_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Prospect Id"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reports/interactions-by-channel":{"get":{"tags":["CRM"],"summary":"Report By Channel","operationId":"report_by_channel_api_v1_reports_interactions_by_channel_get","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":30,"title":"Days"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/reports/funnel":{"get":{"tags":["CRM"],"summary":"Report Funnel","operationId":"report_funnel_api_v1_reports_funnel_get","parameters":[{"name":"mercado","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos | prospeccao_rh | outros | todos","title":"Mercado"},"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos | prospeccao_rh | outros | todos"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dashboard/follow-ups-today":{"get":{"tags":["CRM"],"summary":"Follow Ups Today","operationId":"follow_ups_today_api_v1_dashboard_follow_ups_today_get","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/contacts/channel-click":{"post":{"tags":["CRM"],"summary":"Register Channel Click","operationId":"register_channel_click_api_v1_contacts_channel_click_post","parameters":[{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelClickCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/contacts/channel-click/{click_id}":{"delete":{"tags":["CRM"],"summary":"Delete Channel Click","operationId":"delete_channel_click_api_v1_contacts_channel_click__click_id__delete","parameters":[{"name":"click_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Click Id"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dashboard/whatsapp-educacao-today":{"get":{"tags":["CRM"],"summary":"Whatsapp Educacao Today","operationId":"whatsapp_educacao_today_api_v1_dashboard_whatsapp_educacao_today_get","parameters":[{"name":"mercado","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos","default":"ensino","title":"Mercado"},"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dashboard/email-educacao-today":{"get":{"tags":["CRM"],"summary":"Email Educacao Today","operationId":"email_educacao_today_api_v1_dashboard_email_educacao_today_get","parameters":[{"name":"mercado","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos","default":"ensino","title":"Mercado"},"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dashboard/sms-today":{"get":{"tags":["CRM"],"summary":"Sms Today","operationId":"sms_today_api_v1_dashboard_sms_today_get","parameters":[{"name":"mercado","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos | prospeccao_rh | outros | todos","title":"Mercado"},"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos | prospeccao_rh | outros | todos"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dashboard/ligacao-educacao-today":{"get":{"tags":["CRM"],"summary":"Ligacao Educacao Today","operationId":"ligacao_educacao_today_api_v1_dashboard_ligacao_educacao_today_get","parameters":[{"name":"mercado","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos","default":"ensino","title":"Mercado"},"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dashboard/prospeccao-daily":{"get":{"tags":["CRM"],"summary":"Prospeccao Daily","operationId":"prospeccao_daily_api_v1_dashboard_prospeccao_daily_get","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":90,"minimum":1,"default":14,"title":"Days"}},{"name":"mercado","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos | prospeccao_rh | outros | todos","title":"Mercado"},"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos | prospeccao_rh | outros | todos"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dashboard/metric-companies":{"get":{"tags":["CRM"],"summary":"Dashboard Metric Companies","operationId":"dashboard_metric_companies_api_v1_dashboard_metric_companies_get","parameters":[{"name":"metric","in":"query","required":true,"schema":{"enum":["whatsapp_escolas","email_escolas","sms","ligacao_escolas","interacoes"],"type":"string","title":"Metric"}},{"name":"date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"YYYY-MM-DD (padrão: hoje)","title":"Date"},"description":"YYYY-MM-DD (padrão: hoje)"},{"name":"mercado","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos | prospeccao_rh | outros | todos","title":"Mercado"},"description":"ensino | buffet_eventos | musica | artgeo | prospeccao_rh | outros | todos | prospeccao_rh | outros | todos"},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/":{"get":{"tags":["Home"],"summary":"Home","operationId":"home__get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"BulkInteractionCreate":{"properties":{"cnpjs":{"items":{"type":"string"},"type":"array","maxItems":500,"minItems":1,"title":"Cnpjs"},"channel":{"$ref":"#/components/schemas/Channel"},"direction":{"$ref":"#/components/schemas/Direction","default":"outbound"},"outcome":{"$ref":"#/components/schemas/Outcome"},"occurred_at":{"type":"string","format":"date-time","title":"Occurred At"},"next_follow_up_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Follow Up At"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"user_id":{"type":"string","format":"uuid","title":"User Id"}},"type":"object","required":["cnpjs","channel","outcome","occurred_at","user_id"],"title":"BulkInteractionCreate"},"BulkInteractionItemResult":{"properties":{"cnpj":{"type":"string","title":"Cnpj"},"prospect_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prospect Id"},"status":{"type":"string","enum":["created","skipped","error"],"title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","required":["cnpj","status"],"title":"BulkInteractionItemResult"},"BulkInteractionResponse":{"properties":{"created":{"type":"integer","title":"Created"},"skipped":{"type":"integer","title":"Skipped"},"errors":{"type":"integer","title":"Errors"},"items":{"items":{"$ref":"#/components/schemas/BulkInteractionItemResult"},"type":"array","title":"Items"}},"type":"object","required":["created","skipped","errors","items"],"title":"BulkInteractionResponse"},"Channel":{"type":"string","enum":["whatsapp","telefone","sms","email","linkedin","facebook","instagram","tiktok","visita_presencial","redes_sociais","outro"],"title":"Channel"},"ChannelClickCreate":{"properties":{"channel":{"type":"string","enum":["whatsapp","email","sms","telefone"],"title":"Channel"},"cnpj":{"type":"string","title":"Cnpj"},"razao_social":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Razao Social"},"destinatario":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Destinatario"},"telefone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Telefone"},"is_educacao":{"type":"boolean","title":"Is Educacao","default":false},"source":{"type":"string","pattern":"^(busca|rf_ficha|prospeccao|email_compose|sms_compose)$","title":"Source"},"prospect_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Prospect Id"}},"type":"object","required":["channel","cnpj","source"],"title":"ChannelClickCreate"},"ConsentCreate":{"properties":{"channel":{"$ref":"#/components/schemas/Channel"},"contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Contact Id"},"legal_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Basis"}},"type":"object","required":["channel"],"title":"ConsentCreate"},"ContactCreate":{"properties":{"nome":{"type":"string","title":"Nome"},"telefone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Telefone"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"cargo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cargo"}},"type":"object","required":["nome"],"title":"ContactCreate"},"Direction":{"type":"string","enum":["outbound","inbound"],"title":"Direction"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InteractionCreate":{"properties":{"channel":{"$ref":"#/components/schemas/Channel"},"direction":{"$ref":"#/components/schemas/Direction","default":"outbound"},"outcome":{"$ref":"#/components/schemas/Outcome"},"occurred_at":{"type":"string","format":"date-time","title":"Occurred At"},"next_follow_up_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Follow Up At"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Contact Id"},"duration_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration Seconds"},"user_id":{"type":"string","format":"uuid","title":"User Id"}},"type":"object","required":["channel","outcome","occurred_at","user_id"],"title":"InteractionCreate"},"InteractionOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"channel":{"$ref":"#/components/schemas/Channel"},"direction":{"$ref":"#/components/schemas/Direction"},"outcome":{"$ref":"#/components/schemas/Outcome"},"occurred_at":{"type":"string","format":"date-time","title":"Occurred At"},"next_follow_up_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Follow Up At"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","required":["id","channel","direction","outcome","occurred_at","next_follow_up_at","notes"],"title":"InteractionOut"},"InteractionUpdate":{"properties":{"channel":{"$ref":"#/components/schemas/Channel"},"direction":{"$ref":"#/components/schemas/Direction","default":"outbound"},"outcome":{"$ref":"#/components/schemas/Outcome"},"occurred_at":{"type":"string","format":"date-time","title":"Occurred At"},"next_follow_up_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Follow Up At"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"contact_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Contact Id"},"duration_seconds":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration Seconds"}},"type":"object","required":["channel","outcome","occurred_at"],"title":"InteractionUpdate"},"Outcome":{"type":"string","enum":["sem_resposta","nao_atendeu","conversou_sem_retorno","conversou","demonstrou_interesse","vai_comprar","agendou","reuniao","follow_up","nao_interessado","suporte","outro"],"title":"Outcome"},"ProspectCreate":{"properties":{"cnpj":{"type":"string","title":"Cnpj","examples":["11222333000181"]}},"type":"object","required":["cnpj"],"title":"ProspectCreate"},"ProspectListItemOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"cnpj":{"type":"string","title":"Cnpj"},"status":{"$ref":"#/components/schemas/ProspectStatus"},"status_label":{"type":"string","title":"Status Label"},"razao_social":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Razao Social"},"nome_fantasia":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nome Fantasia"},"segmento_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Segmento Label"},"porte_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Porte Label"},"socio_faixa_etaria_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Socio Faixa Etaria Label"},"contato_nome":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contato Nome"},"contato_papel":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contato Papel"},"demonstrou_interesse":{"type":"boolean","title":"Demonstrou Interesse","default":false},"teve_follow_up":{"type":"boolean","title":"Teve Follow Up","default":false},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","cnpj","status","status_label","created_at"],"title":"ProspectListItemOut"},"ProspectListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ProspectListItemOut"},"type":"array","title":"Items"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"}},"type":"object","required":["items","limit","offset"],"title":"ProspectListResponse"},"ProspectOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"cnpj":{"type":"string","title":"Cnpj"},"status":{"$ref":"#/components/schemas/ProspectStatus"},"discard_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Discard Reason"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","cnpj","status","discard_reason","created_at"],"title":"ProspectOut"},"ProspectStatus":{"type":"string","enum":["novo","em_contato","qualificado","descartado","convertido"],"title":"ProspectStatus"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}