# Dominios

### Listar todos os domínios

## Listar dominios

<mark style="color:blue;">`GET`</mark> `/dominios/listar`

Lista todos os dominios existentes na base de consulta.&#x20;

Filtros estão disponíveis

#### Query Parameters

| Name        | Type   | Description                                                                                                            |
| ----------- | ------ | ---------------------------------------------------------------------------------------------------------------------- |
| dominio     | String | filtra pelo domínio da conta/serviço                                                                                   |
| id\_cliente | Number | Filtra pelo id do cliente listando apenas os serviços de determinado cliente                                           |
| status      | String | <p>Filtra pelo status do Serviço</p><p><br>S -> Ativo</p><p>P -> Pendente</p><p>C -> Cancelado</p><p>B -> Expirado</p> |
| registros   | Number | <p>Quantidade de registros a serem listados por consulta (pagina)<br><br>Se não informado, adota 20 por padrão</p>     |
| pagina      | Number | <p>Página atual da consulta (registros listados em paginação)<br>padrão: 1</p>                                         |

{% tabs %}
{% tab title="200: OK Retorna objeto com a lista de dominios" %}

```json
{
    "status": "sucesso",
    "dados": {
        "total_registros": 16,
        "paginas": 16,
        "pagina": 1,
        "mostrando": "Registros de 1 até 1",
        "clientes": [
            {
                "id_dominio": "23",
                "id_cliente": "1",
                "id_pedido": "162",
                "id_afiliado": "0",
                "dominio": "kjsdfhksdhfkshdkfjsdsd.com",
                "status": "P",
                "registrante": "",
                "dns1": "",
                "dns2": "",
                "dns3": null,
                "dns4": null,
                "valor": "45.00",
                "valor_recorrente": "45.00",
                "data_cadastro": "2023-06-10",
                "data_vencimento": "2024-06-07",
                "data_expiracao": "2024-06-09",
                "periodo": "1",
                "promocao": "0",
                "notas": null
            }
        ]
    }
}
```

{% endtab %}

{% tab title="404: Not Found Objeto contendo erro" %}

```json
{
    "status": "erro",
    "dados": "não há dominios cadastrados"
}
```

{% endtab %}
{% endtabs %}

### Busca um serviço determinado

## Busca dados de um dominio determinado

<mark style="color:blue;">`GET`</mark> `/dominios/listar/{ID}`

responsável por listar dados de uma conta/serviço.

#### Path Parameters

| Name                                 | Type   | Description   |
| ------------------------------------ | ------ | ------------- |
| ID<mark style="color:red;">\*</mark> | Number | ID do dominio |

{% tabs %}
{% tab title="200: OK retorna um Objeto com os dados do dominio" %}

```json
{
    "status": "sucesso",
    "dados": [
        {
            "id_dominio": "9",
            "id_cliente": "1",
            "id_pedido": "0",
            "id_afiliado": "0",
            "dominio": "tudomais.net",
            "status": "S",
            "registrante": "freenom",
            "dns1": "ns1.tudohost.com.br",
            "dns2": "ns2.tudohost.com.br",
            "dns3": "ns3.tudohost.com.br",
            "dns4": "ns4.tudohost.com.br",
            "valor": "55.00",
            "valor_recorrente": "55.00",
            "data_cadastro": "0000-00-00",
            "data_vencimento": "2023-05-10",
            "data_expiracao": "2019-05-10",
            "periodo": "1",
            "promocao": "0",
            "notas": ""
        }
    ]
}
```

{% endtab %}

{% tab title="404: Not Found Erro na consulta" %}

```json
{
    "status": "erro",
    "dados": "não há serviços cadastrados"
}
```

{% 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://hostmgr.gitbook.io/desenvolvedores/api-reference/dominios.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.