API Reference

Listar projetos

Exibe uma lista contendo todos os projetos cadastrados

GET - 200

{
  "total": 1,
  "page_index": 0,
  "page_size": 15,
  "results": {
    "id": 1,
    "name": "Nome do projeto - (P002 - 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,
    "company_id": 1,
    "company": {
      "id": 1,
      "name": "Nome da companhia",
      "full_name": "Nome completo da companhia",
      "email": "[email protected]",
      "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"
    },
    "contact_id": 1,
    "contact": {
      "id": 1,
      "name": "Nome do contato",
      "full_name": "Nome completo do contato",
      "email": "[email protected]",
      "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"
    },
    "deal": {
			"id": 1,
			"name": "NGC001 - ATENDARE"
		},
		"deal_id": 1,
    "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 protected]",
      "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 protected]",
          "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 protected]",
          "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"
  }
}
Language
Click Try It! to start a request and see the response here!