--- agentTools: projectIndex: https://atendare.readme.io/llms.txt --- # Listar negociações Exibe uma lista de todas negociações cadastradas ```json GET - 200 { "total": 1, "page_index": 0, "page_size": 15, "results": { "id": 1, "name": "Nome da negociação - (NGC2 - Amazon)", "start_date": "2022-03-23T16:51:58Z", "end_date": "2022-03-23T16:51:58Z", "value": 5000, "estimated_value": 5000, "number": 1, "status": 1, "visibility": 2, "currency_id": 1, "currency": { "id": 1, "name": "Brazilian real", "symbol": "R$", "territory": "Brazil", "iso_code": "BRL", "is_default": false, "thousands": ".", "decimal": ",", "precision": 3 }, "company_id": 1, "company": { "id": 1, "name": "Nome da companhia", "full_name": "Nome completo da companhia", "email": "email@atendare.com", "phone": "55 9 99999999", "document": "294.515.040-95", "image": "https://image-url/image.png", "image_min": "https://image-url/image.png", "show_name": "Nome exibido da companhia" }, "qualification_id": 1, "contact_id": 1, "contact": { "id": 1, "name": "Nome do contato", "full_name": "Nome completo do contato", "email": "email@atendare.com", "phone": "55 9 99999999", "document": "294.515.040-95", "image": "https://image-url/image.png", "image_min": "https://image-url/image.png", "show_name": "Nome exibido do contato" }, "pipeline_id": 1, "pipeline": { "id": 1, "name": "Nome da pipeline" }, "stage_id": 1, "stage": { "id": 1, "name": "Nome do estágio no momento", "status": 2, "percentage": 100 }, "source_id": 1, "source": { "id": 1, "name": "Instagram" }, "last_stage_id": 1, "responsible_id": 1, "responsible": { "id": 1, "name": "Nome do responsável", "full_name": "Nome completo do responsável", "email": "email@atendare.com", "phone": "55 9 99999999", "document": "294.515.040-95", "image": "https://image-url/image.png", "image_min": "https://image-url/image.png", "show_name": "Nome exibido do responsável " }, "author_id": 1, "author": { "id": 1, "detail": "Nome do autor", "type": 1, "user_id": 1, "automation_id": 1, "form_id": 1, "import_id": 1, "user_uid": 1 }, "creation_date": "2020-12-10T17:35:29Z", "update_date": "2022-06-09T12:34:16Z", "lastupdate_stage": "2022-06-09T12:34:16Z", "products": [ { "id": 1, "deal_id": 1, "document_id": 1, "product_id": 1, "product": { "id": 1, "measuringunit_id": 1, "measuringunit": { "id": 1, "name": "Unidade (metros)", "unit": "M" }, "category_id": 1, "category": { "id": 1, "name": "Nome da categoria" }, "max_discount": 80.0, "image": "https://image-url/image.png", "image_min": "https://image-url/image.png", "edit_costprice": true, "edit_unitprice": true, "name": "Nome do produto", "type": 1, "reference": "Nome da refêrencia" }, "name": "Nome do produto", "order": 0, "amount": 1.0, "cost_price": 1000.12, "unit_price": 2000.12, "sub_total": 234.11, "discount": 80.0, "discount_percent": 80.0, "total": 1000.12, "description": "Descrição do produto" } ], "participants": [ { "id": 1, "opp_id": 1, "person_id": 1, "person": { "id": 1, "name": "Nome da empresa/contato", "full_name": "Nome completo empresa/contato", "email": "email@atendare.com", "phone": "55 9 99999999", "document": "294.515.040-95", "image": "https://image-url/image.png", "image_min": "https://image-url/image.png", "show_name": "Nome completo empresa/contato" }, "user_id": 1, "user": { "id": 1, "name": "Nome da conta", "full_name": "Nome completo da conta", "email": "email@atendare.com", "phone": "55 9 99999999", "document": "294.515.040-95", "image": "https://image-url/image.png", "image_min": "https://image-url/image.png", "show_name": "Nome completo da conta" }, "is_main": false, "type_id": 1, "type": { "id": 1, "name": "Influenciador" } } ], "tags": [ { "id": 1, "name": "Nome da tag", "color": "#ffffff" } ], "custom_example": "Valor do campo personalizado" } } ``` # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Atendare API - v2", "version": "2.0" }, "servers": [ { "url": "https://api.atendare.com/v2" } ], "security": [ {} ], "paths": { "/deals": { "get": { "summary": "Listar negociações", "description": "Exibe uma lista de todas negociações cadastradas", "operationId": "list-deals", "parameters": [ { "name": "page_index", "in": "query", "description": "Para paginação, representa o primeiro elemento da lista.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "page_size", "in": "query", "description": "Para paginação, define o total de contatos que ira ser retornado em uma lista. O limite é 100", "schema": { "type": "integer", "format": "int32", "default": 15 } }, { "name": "search_text", "in": "query", "description": "Termo usado para pesquisar", "schema": { "type": "string" } }, { "name": "sort_field", "in": "query", "description": "Campo a ser ordenado", "schema": { "type": "string" } }, { "name": "sort_order", "in": "query", "description": "Tipo de ordenação crescente (ASC) ou decrescente (DESC), o padrão é crescente", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "properties": { "condition": { "type": "string", "description": "Or - And" }, "conditions": { "type": "array", "items": { "properties": { "field": { "type": "string", "description": "Campo que você deseja filtrar" }, "operation": { "type": "string", "enum": [ "equal", "not_equal", "less", "less_or_equal", "greater", "greater_or_equal", "begins_with", "does_not_begin_with", "is_in", "is_not_in", "ends_with", "does_not_end_with", "contains", "does_not_contains", "is_empty", "is_not_empty", "between", "does_not_between" ] }, "value": { "type": "string" } }, "type": "object" } } }, "type": "object" } }, { "name": "Access-Token", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"total\": 1,\n\t\"page_index\": 0,\n\t\"page_size\": 15,\n \"results\": {\n \"id\": 1,\n \"name\": \"NGC001 - Nome da negociação\",\n \"start_date\": \"2022-03-23T16:51:58Z\",\n \"end_date\": \"2022-03-23T16:51:58Z\",\n \"value\": 5000.0,\n \"estimated_value\": 5000.0,\n \"number\": 1,\n \"status\": 1,\n \"visibility\": 2,\n \"currency_id\": 1,\n \"currency\": {\n \"id\": 1,\n \"name\": \"Brazilian real\",\n \"symbol\": \"R$\",\n \"territory\": \"Brazil\",\n \"iso_code\": \"BRL\",\n \"is_default\": false,\n \"thousands\": \".\",\n \"decimal\": \",\",\n \"precision\": 3\n },\n \"company_id\": 1,\n \"company\": {\n \"id\": 1,\n \"name\": \"Nome da companhia\",\n \"full_name\": \"Nome completo da companhia\",\n \"email\": \"email@atendare.com\",\n \"phone\": \"55 9 99999999\",\n \"document\": \"294.515.040-95\",\n \"image\": \"https://image-url/image.png\",\n \"image_min\": \"https://image-url/image.png\",\n \"show_name\": \"Nome exibido da companhia\"\n },\n \"qualification_id\": 1,\n \"contact_id\": 1,\n \"contact\": {\n \"id\": 1,\n \"name\": \"Nome do contato\",\n \"full_name\": \"Nome completo do contato\",\n \"email\": \"email@atendare.com\",\n \"phone\": \"55 9 99999999\",\n \"document\": \"294.515.040-95\",\n \"image\": \"https://image-url/image.png\",\n \"image_min\": \"https://image-url/image.png\",\n \"show_name\": \"Nome exibido do contato\"\n },\n \"pipeline_id\": 1,\n \"pipeline\": {\n \"id\": 1,\n \"name\": \"Nome da pipeline\"\n },\n \"stage_id\": 1,\n \"stage\": {\n \"id\": 1,\n \"name\": \"Nome do estágio no momento\",\n \"status\": 2,\n \"percentage\": 100\n },\n \"source_id\": 1,\n \"source\": {\n \"id\": 1,\n \"name\": \"Instagram\"\n },\n \"last_stage_id\": 1,\n \"responsible_id\": 1,\n \"responsible\": {\n \"id\": 1,\n \"name\": \"Nome do responsável\",\n \"full_name\": \"Nome completo do responsável\",\n \"email\": \"email@atendare.com\",\n \"phone\": \"55 9 99999999\",\n \"document\": \"294.515.040-95\",\n \"image\": \"https://image-url/image.png\",\n \"image_min\": \"https://image-url/image.png\",\n \"show_name\": \"Nome exibido do responsável \"\n },\n \"author_id\": 1,\n \"author\": {\n \"id\": 1,\n \"detail\": \"Nome do autor\",\n \"type\": 1,\n \"user_id\": 1,\n \"automation_id\": 1,\n \"form_id\": 1,\n \"import_id\": 1,\n \"user_uid\": 1\n },\n \"creation_date\": \"2020-12-10T17:35:29Z\",\n \"update_date\": \"2022-06-09T12:34:16Z\",\n \"lastupdate_stage\": \"2022-06-09T12:34:16Z\",\n \"products\": [\n {\n \"id\": 1,\n \"deal_id\": 1,\n \"document_id\": 1,\n \"product_id\": 1,\n \"product\": {\n \"id\": 1,\n \"measuringunit_id\": 1,\n \"measuringunit\": {\n \"id\": 1,\n \"name\": \"Unidade (metros)\",\n \"unit\": \"M\"\n },\n \"category_id\": 1,\n \"category\": {\n \"id\": 1,\n \"name\": \"Nome da categoria\"\n },\n \"max_discount\": 80.0,\n \"image\": \"https://image-url/image.png\",\n \"image_min\": \"https://image-url/image.png\",\n \"edit_costprice\": true,\n \"edit_unitprice\": true,\n \"name\": \"Nome do produto\",\n \"type\": 1,\n \"reference\": \"Nome da refêrencia\"\n },\n \"name\": \"Nome do produto\",\n \"order\": 0,\n \"amount\": 1.0,\n \"cost_price\": 1000.12,\n \"unit_price\": 2000.12,\n \"sub_total\": 234.11,\n \"discount\": 80.0,\n \"discount_percent\": 80.0,\n \"total\": 1000.12,\n \"description\": \"Descrição do produto\"\n }\n ],\n \"participants\": [\n {\n \"id\": 1,\n \"opp_id\": 1,\n \"person_id\": 1,\n \"person\": {\n \"id\": 1,\n \"name\": \"Nome da empresa/contato\",\n \"full_name\": \"Nome completo empresa/contato\",\n \"email\": \"email@atendare.com\",\n \"phone\": \"55 9 99999999\",\n \"document\": \"294.515.040-95\",\n \"image\": \"https://image-url/image.png\",\n \"image_min\": \"https://image-url/image.png\",\n \"show_name\": \"Nome completo empresa/contato\"\n },\n \"user_id\": 1,\n \"user\": {\n \"id\": 1,\n \"name\": \"Nome da conta\",\n \"full_name\": \"Nome completo da conta\",\n \"email\": \"email@atendare.com\",\n \"phone\": \"55 9 99999999\",\n \"document\": \"294.515.040-95\",\n \"image\": \"https://image-url/image.png\",\n \"image_min\": \"https://image-url/image.png\",\n \"show_name\": \"Nome completo da conta\"\n },\n \"is_main\": false,\n \"type_id\": 1,\n \"type\": {\n \"id\": 1,\n \"name\": \"Influenciador\"\n }\n }\n ],\n \"tags\": [\n {\n \"id\": 1,\n \"name\": \"Nome da tag\",\n \"color\": \"#ffffff\"\n }\n ],\n \"custom_example\": \"Valor do campo personalizado\"\n }\n}\n" } }, "schema": { "type": "object", "properties": { "total": { "type": "integer", "example": 1, "default": 0 }, "page_index": { "type": "integer", "example": 0, "default": 0 }, "page_size": { "type": "integer", "example": 15, "default": 0 }, "results": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "NGC001 - Nome da negociação" }, "start_date": { "type": "string", "example": "2022-03-23T16:51:58Z" }, "end_date": { "type": "string", "example": "2022-03-23T16:51:58Z" }, "value": { "type": "integer", "example": 5000, "default": 0 }, "estimated_value": { "type": "integer", "example": 5000, "default": 0 }, "number": { "type": "integer", "example": 1, "default": 0 }, "status": { "type": "integer", "example": 1, "default": 0 }, "visibility": { "type": "integer", "example": 2, "default": 0 }, "currency_id": { "type": "integer", "example": 1, "default": 0 }, "currency": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Brazilian real" }, "symbol": { "type": "string", "example": "R$" }, "territory": { "type": "string", "example": "Brazil" }, "iso_code": { "type": "string", "example": "BRL" }, "is_default": { "type": "boolean", "example": false, "default": true }, "thousands": { "type": "string", "example": "." }, "decimal": { "type": "string", "example": "," }, "precision": { "type": "integer", "example": 3, "default": 0 } } }, "company_id": { "type": "integer", "example": 1, "default": 0 }, "company": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Nome da companhia" }, "full_name": { "type": "string", "example": "Nome completo da companhia" }, "email": { "type": "string", "example": "email@atendare.com" }, "phone": { "type": "string", "example": "55 9 99999999" }, "document": { "type": "string", "example": "294.515.040-95" }, "image": { "type": "string", "example": "https://image-url/image.png" }, "image_min": { "type": "string", "example": "https://image-url/image.png" }, "show_name": { "type": "string", "example": "Nome exibido da companhia" } } }, "qualification_id": { "type": "integer", "example": 1, "default": 0 }, "contact_id": { "type": "integer", "example": 1, "default": 0 }, "contact": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Nome do contato" }, "full_name": { "type": "string", "example": "Nome completo do contato" }, "email": { "type": "string", "example": "email@atendare.com" }, "phone": { "type": "string", "example": "55 9 99999999" }, "document": { "type": "string", "example": "294.515.040-95" }, "image": { "type": "string", "example": "https://image-url/image.png" }, "image_min": { "type": "string", "example": "https://image-url/image.png" }, "show_name": { "type": "string", "example": "Nome exibido do contato" } } }, "pipeline_id": { "type": "integer", "example": 1, "default": 0 }, "pipeline": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Nome da pipeline" } } }, "stage_id": { "type": "integer", "example": 1, "default": 0 }, "stage": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Nome do estágio no momento" }, "status": { "type": "integer", "example": 2, "default": 0 }, "percentage": { "type": "integer", "example": 100, "default": 0 } } }, "source_id": { "type": "integer", "example": 1, "default": 0 }, "source": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Instagram" } } }, "last_stage_id": { "type": "integer", "example": 1, "default": 0 }, "responsible_id": { "type": "integer", "example": 1, "default": 0 }, "responsible": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Nome do responsável" }, "full_name": { "type": "string", "example": "Nome completo do responsável" }, "email": { "type": "string", "example": "email@atendare.com" }, "phone": { "type": "string", "example": "55 9 99999999" }, "document": { "type": "string", "example": "294.515.040-95" }, "image": { "type": "string", "example": "https://image-url/image.png" }, "image_min": { "type": "string", "example": "https://image-url/image.png" }, "show_name": { "type": "string", "example": "Nome exibido do responsável " } } }, "author_id": { "type": "integer", "example": 1, "default": 0 }, "author": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "detail": { "type": "string", "example": "Nome do autor" }, "type": { "type": "integer", "example": 1, "default": 0 }, "user_id": { "type": "integer", "example": 1, "default": 0 }, "automation_id": { "type": "integer", "example": 1, "default": 0 }, "form_id": { "type": "integer", "example": 1, "default": 0 }, "import_id": { "type": "integer", "example": 1, "default": 0 }, "user_uid": { "type": "integer", "example": 1, "default": 0 } } }, "creation_date": { "type": "string", "example": "2020-12-10T17:35:29Z" }, "update_date": { "type": "string", "example": "2022-06-09T12:34:16Z" }, "lastupdate_stage": { "type": "string", "example": "2022-06-09T12:34:16Z" }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "deal_id": { "type": "integer", "example": 1, "default": 0 }, "document_id": { "type": "integer", "example": 1, "default": 0 }, "product_id": { "type": "integer", "example": 1, "default": 0 }, "product": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "measuringunit_id": { "type": "integer", "example": 1, "default": 0 }, "measuringunit": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Unidade (metros)" }, "unit": { "type": "string", "example": "M" } } }, "category_id": { "type": "integer", "example": 1, "default": 0 }, "category": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Nome da categoria" } } }, "max_discount": { "type": "integer", "example": 80, "default": 0 }, "image": { "type": "string", "example": "https://image-url/image.png" }, "image_min": { "type": "string", "example": "https://image-url/image.png" }, "edit_costprice": { "type": "boolean", "example": true, "default": true }, "edit_unitprice": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Nome do produto" }, "type": { "type": "integer", "example": 1, "default": 0 }, "reference": { "type": "string", "example": "Nome da refêrencia" } } }, "name": { "type": "string", "example": "Nome do produto" }, "order": { "type": "integer", "example": 0, "default": 0 }, "amount": { "type": "integer", "example": 1, "default": 0 }, "cost_price": { "type": "number", "example": 1000.12, "default": 0 }, "unit_price": { "type": "number", "example": 2000.12, "default": 0 }, "sub_total": { "type": "number", "example": 234.11, "default": 0 }, "discount": { "type": "integer", "example": 80, "default": 0 }, "discount_percent": { "type": "integer", "example": 80, "default": 0 }, "total": { "type": "number", "example": 1000.12, "default": 0 }, "description": { "type": "string", "example": "Descrição do produto" } } } }, "participants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "opp_id": { "type": "integer", "example": 1, "default": 0 }, "person_id": { "type": "integer", "example": 1, "default": 0 }, "person": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Nome da empresa/contato" }, "full_name": { "type": "string", "example": "Nome completo empresa/contato" }, "email": { "type": "string", "example": "email@atendare.com" }, "phone": { "type": "string", "example": "55 9 99999999" }, "document": { "type": "string", "example": "294.515.040-95" }, "image": { "type": "string", "example": "https://image-url/image.png" }, "image_min": { "type": "string", "example": "https://image-url/image.png" }, "show_name": { "type": "string", "example": "Nome completo empresa/contato" } } }, "user_id": { "type": "integer", "example": 1, "default": 0 }, "user": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Nome da conta" }, "full_name": { "type": "string", "example": "Nome completo da conta" }, "email": { "type": "string", "example": "email@atendare.com" }, "phone": { "type": "string", "example": "55 9 99999999" }, "document": { "type": "string", "example": "294.515.040-95" }, "image": { "type": "string", "example": "https://image-url/image.png" }, "image_min": { "type": "string", "example": "https://image-url/image.png" }, "show_name": { "type": "string", "example": "Nome completo da conta" } } }, "is_main": { "type": "boolean", "example": false, "default": true }, "type_id": { "type": "integer", "example": 1, "default": 0 }, "type": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Influenciador" } } } } } }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 1, "default": 0 }, "name": { "type": "string", "example": "Nome da tag" }, "color": { "type": "string", "example": "#ffffff" } } } }, "custom_example": { "type": "string", "example": "Valor do campo personalizado" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "61f3f7309a3abf0010b92516:62697bf86ba8b600768b33c0" } ```