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

# GET Key

> Connaître le type de votre clé API et les méthodes qu'elle autorise, avant qu'un 403 vous l'apprenne.

Renvoie le **type** de la clé utilisée pour l'appel et la liste des méthodes HTTP qu'elle autorise. Voir [Types de clé](https://developers.avest.fr/guides/authentification.md).

## Endpoint

**URL** : `/external-integration/key`
**Méthode** : `GET`
**Authentification** : token LinkedAPI avec scope `externalIntegration`.
**Clé requise** : toutes les clés (lecture seule suffit). Voir [Types de clé](https://developers.avest.fr/guides/authentification.md).

## Exemple

```bash theme={null}
curl "https://api.avest.fr/v1/external-integration/key" \
  -H "Authorization: Bearer {token}"
```

## Réponse de succès

**Code** : `200`

```json theme={null}
{
  "success": true,
  "key": {
    "id": "6a01f74807e0bd434ec46fc4",
    "name": "Mon intégration",
    "access": "readWrite",
    "methods": ["POST", "GET", "PATCH"],
    "secure": false
  }
}
```

| Champ | Type | Description |
| - | - | - |
| `id` | ObjectId | Identifiant de la clé. À communiquer à Avest pour toute demande sur votre clé. |
| `name` | String | Nom de la clé. |
| `access` | String | `readOnly`, `readWrite` ou `readWriteDelete`. `custom` pour certaines clés anciennes : fiez-vous alors à `methods`. |
| `methods` | String\[] | Méthodes HTTP autorisées. C'est la référence : une méthode absente de la liste reçoit `403`. |
| `secure` | Boolean | `true` si la clé n'accepte que les appels depuis une IP autorisée. Voir [Clés sécurisées](https://developers.avest.fr/guides/authentification.md). |

Le token et l'IP autorisée ne sont jamais renvoyés.

> [!TIP]
>
> Appelez cette route au démarrage de votre intégration. Si `methods` ne contient
> pas ce dont vous avez besoin, contactez Avest **avant** d'écrire, plutôt que de
> découvrir le problème sur un `403`.

## Rate limits

**500 req / minute par groupe d'agences** (bucket de lecture).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.