> ## Documentation Index
> Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET/Projects

> Guía de API para consultar la configuración del proyecto

Esta API devuelve la configuración actual de su proyecto.

<Warning>
  Esta API proporciona una instantánea para asistir con las operaciones, y la estructura de respuesta puede cambiar sin previo aviso debido a actualizaciones del servicio.
</Warning>

## Encabezado de Autenticación

La API de ARGOS utiliza la clave secreta en el encabezado x-api-key para autenticación. Puede encontrar su clave secreta en la configuración del proyecto en el dashboard.

Al realizar solicitudes API, incluya su clave API en el encabezado `x-api-key` de la siguiente manera:

```bash theme={null}
x-api-key: {yourAPIKey}
```

## Solicitud

### Parámetros de consulta

<ParamField query="category" type="string">
  Puede verificar los valores actuales de configuración para una categoría específica.

  El filtrado es posible pasando una cadena separada por comas. Se agregarán categorías adicionales en el futuro.

  **Valores posibles:** `management`

  **Ejemplo:** `category=management`
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET 'https://rest-api.argosidentity.com/v3/projects/settings?category=management' \
  -H 'x-api-key: {yourAPIKey}'
  ```
</RequestExample>

## Respuesta

### Respuesta exitosa

<ResponseField name="traceId" type="string">
  Identificador único para la solicitud API emitido por ARGOS. Incluir el traceId en su consulta le ayudará a obtener una respuesta más rápida.
</ResponseField>

<ResponseField name="item" type="object">
  Información actual de configuración del proyecto.

  <Expandable title="Propiedades">
    <ResponseField name="management" type="object">
      Información de configuración relacionada con la gestión del proyecto.

      <Expandable title="Propiedades de management">
        <ResponseField name="activateBlocking" type="object">
          Estado actual basado en el sistema de control de envíos. Devuelve valor inactivo cuando la operación del sistema está detenida.<br />
          "activateBlocking" no se verá afectado por actualizaciones dentro de la misma versión.

          <Expandable title="Propiedades">
            <ResponseField name="activate" type="boolean">
              Si el sistema de control de envíos está activado.
            </ResponseField>

            <ResponseField name="latestExecutionTime" type="string">
              La hora en que se activó por última vez el control de envíos (ISO8601).
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="admins" type="array">
          Información de administradores almacenada en el dashboard.
        </ResponseField>

        <ResponseField name="description" type="string">
          Descripción del proyecto configurada en el dashboard.
        </ResponseField>

        <ResponseField name="formPrivacyPolicyUrl" type="string">
          URL de política de privacidad configurada en el dashboard.
        </ResponseField>

        <ResponseField name="formReturnUrl" type="string">
          URL de retorno configurada en el dashboard.
        </ResponseField>

        <ResponseField name="formReturnUrlConfig" type="object">
          Configuración de opciones dentro de la URL de retorno.

          <Expandable title="Propiedades">
            <ResponseField name="cf1" type="boolean">
              Si se incluye el campo personalizado 1
            </ResponseField>

            <ResponseField name="cf2" type="boolean">
              Si se incluye el campo personalizado 2
            </ResponseField>

            <ResponseField name="cf3" type="boolean">
              Si se incluye el campo personalizado 3
            </ResponseField>

            <ResponseField name="email" type="boolean">
              Si se incluye el email
            </ResponseField>

            <ResponseField name="kycStatus" type="boolean">
              Si se incluye el estado KYC
            </ResponseField>

            <ResponseField name="submissionId" type="boolean">
              Si se incluye el ID de submission
            </ResponseField>

            <ResponseField name="userId" type="boolean">
              Si se incluye el ID de usuario
            </ResponseField>

            <ResponseField name="skipResultPage" type="boolean">
              Si se omite la página de resultados
            </ResponseField>

            <ResponseField name="isEncrypted" type="boolean">
              Si el cifrado está habilitado
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="formTermsOfUseUrl" type="string">
          URL de términos de uso almacenada.
        </ResponseField>

        <ResponseField name="ipWhitelist" type="object">
          Lista de IPs permitidas para acceso al dashboard y API.

          <Expandable title="Propiedades">
            <ResponseField name="admin" type="array">
              Lista de IPs permitidas para acceso al dashboard
            </ResponseField>

            <ResponseField name="api" type="array">
              Lista de IPs permitidas para acceso a la API
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="name" type="string">
          Nombre del proyecto configurado.
        </ResponseField>

        <ResponseField name="projectStatus" type="string">
          Estado operacional actual del proyecto. Contacte al administrador de ARGOS si desea cambiarlo.

          **Valores posibles:** `Trial`, `Test`, `Service`, `Closed`
        </ResponseField>

        <ResponseField name="webhook" type="object">
          Configuración de webhook almacenada en el proyecto.

          <Expandable title="Propiedades">
            <ResponseField name="createTime" type="string">
              Hora de registro del webhook
            </ResponseField>

            <ResponseField name="url" type="string">
              URL para recibir webhooks
            </ResponseField>

            <ResponseField name="members" type="array">
              Lista de miembros del webhook

              <Expandable title="Propiedades de miembros">
                <ResponseField name="name" type="string">
                  Nombre del miembro del webhook
                </ResponseField>

                <ResponseField name="addDate" type="string">
                  Hora en que se agregó el miembro del webhook (ISO8601)
                </ResponseField>

                <ResponseField name="email" type="string">
                  Email del miembro del webhook
                </ResponseField>
              </Expandable>
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json Success theme={null}
  {
    "traceId": "019a57b8-2bca-73de-94f0-220def0b60ee",
    "item": {
      "management": {
        "activateBlocking": {
          "activate": false
        },
        "admins": [
          "test@argosidentity.com"
        ],
        "description": " ",
        "formPrivacyPolicyUrl": " ",
        "formReturnUrl": " ",
        "formReturnUrlConfig": {
          "cf1": false,
          "cf2": false,
          "cf3": false,
          "email": false,
          "kycStatus": false,
          "submissionId": false,
          "userId": false,
          "skipResultPage": false,
          "isEncrypted": false
        },
        "formTermsOfUseUrl": " ",
        "ipWhitelist": {
          "admin": [],
          "api": []
        },
        "name": "test-project",
        "projectStatus": "open",
        "webhook": {
          "createTime": "2025-05-07T09:07:28.775Z",
          "url": "https://test.argosidentity.com",
          "members": [
            {
              "name": "test-member",
              "addDate": "2025-06-10T01:35:07.053Z",
              "email": "test@argosidentity.com"
            }
          ]
        }
      }
    }
  }
  ```
</ResponseExample>

### Respuesta de error

**Códigos de Error**

| statusCode | code              | message                                           |
| ---------- | ----------------- | ------------------------------------------------- |
| 400        | BAD\_REQUEST      | Invalid query parameters                          |
| 400        | INVALID\_CATEGORY | Invalid category parameter: \[invalid categories] |

<ResponseExample>
  ```json Error theme={null}
  {
    "traceId": "018f1234-5678-90ab-cdef-123456789abc",
    "code": "BAD_REQUEST",
    "message": "Invalid query parameters"
  }
  ```
</ResponseExample>