# Prospectos

## Obtener un listado de Prospectos

<mark style="color:blue;">`GET`</mark> `https://{clave}.admintotal.com/api/v2/prospectos/`

#### Headers

| Name    | Type   | Description            |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |

{% tabs %}
{% tab title="200: OK " %}

```javascript
{
    "count": 33,
    "next": "https://{clave}.admintotal.com/api/v2/prospectos/",
    "previous": null,
    "results": [
        {
            "id": 2,
            "codigo": "02",
            "empresa": "Mexicana",
            "nombre_comercial": null,
            "sucursal": null,
            "nombre": "rogelio amarillas",
            "rfc": null,
            "recomendo": "claudia robles",
            "status": 1,
            "comentarios": "visitar hoy",
            "stats_display": "Negociación",
            "cotizaciones": []
        }
    ]
}
```

{% endtab %}
{% endtabs %}

## Crear Prospecto

<mark style="color:green;">`POST`</mark> `https://{clave}.admintotal.com/api/v2/prospectos/`

#### Headers

| Name    | Type   | Description            |
| ------- | ------ | ---------------------- |
| Api-key | string | Token de autenticación |

#### Request Body

<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>codigo</td><td>char</td><td>Codigo de prospecto</td></tr><tr><td>nombre</td><td>char</td><td>Nombre completo del prospecto</td></tr><tr><td>empresa</td><td>char</td><td>Nombre completo del prospecto</td></tr><tr><td>nombre_comercial</td><td>char</td><td>Nombre cormercial del prospecto</td></tr><tr><td>sucursal</td><td>char</td><td>Nombre sucursal del prospecto</td></tr><tr><td>rfc (opcional)</td><td>char</td><td>RFC del prospecto</td></tr><tr><td>recomendo</td><td>char</td><td>Nombre de la persona que recomendo al prospecto</td></tr><tr><td>status</td><td>integer</td><td><p>Status del prospecto                    </p><pre class="language-python"><code class="lang-python">0 - "Nuevo"
1 - "Negociación"
2 - "Ganado"
3 - "Desactivado"
4 - "Perdido"
</code></pre></td></tr><tr><td>direccion </td><td>object</td><td><p></p><p>Objeto  con la información de dirección, ejemplo:</p><pre class="language-json"><code class="lang-json">{
    "nombre": "Ejemplo 1",
    "direccion": {
      "municipio": "Hermosillo",
      "localidad": "Hermosillo",
      "estado": "Sonora",
      "calle": "Articulo 123",
      "colonia": "Misión del sol",
      "cp": "83100",
      "telefono": "",
      "email": "",
      "numero_e": "93A",
      "numero_i": "",
      "pais_residencia": "MEX",
      "latitud": null,
      "longitud": null,
      "referencia": ""
    }
}
</code></pre></td></tr></tbody></table>

## Obtener  un Prospecto

<mark style="color:blue;">`GET`</mark> `https://{clave}.admintotal.com/api/v2/prospectos/:id/`

#### Headers

| Name    | Type   | Description            |
| ------- | ------ | ---------------------- |
| Api-key | String | Token de autenticación |

{% tabs %}
{% tab title="200: OK " %}

```javascript
{
    "count": 33,
    "next": "https://{clave}.admintotal.com/api/v2/prospectos/",
    "previous": null,
    "results": [
        {
            "id": 2,
            "codigo": "02",
            "empresa": "Mexicana",
            "nombre_comercial": null,
            "sucursal": null,
            "nombre": "rogelio amarillas",
            "rfc": null,
            "recomendo": "claudia robles",
            "status": 1,
            "comentarios": "visitar hoy",
            "stats_display": "Negociación",
            "cotizaciones": []
        }
    ]
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: 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.admintotal.com/api/prospectos.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.