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

# Obtenir les campagnes

> Récupérez la liste paginée des campagnes CrowdChange où l'utilisateur authentifié est inscrit, incluant rôle, objectif et montant amassé par campagne.

## Paramètres de requête

<ParamField query="token" type="string" required>
  Jeton d'accès de l'utilisateur.
</ParamField>

<ParamField query="text" type="string">
  Terme de recherche.
</ParamField>

<ParamField query="page" type="integer">
  Numéro de page. Par défaut : `1`
</ParamField>

<ParamField query="limit" type="integer">
  Nombre de résultats à retourner. Par défaut : `10`
</ParamField>

<ParamField query="sort" type="string">
  Clé de tri. Valeurs permises : `name`, `amount_raised`, `amount_goal`
</ParamField>

<ParamField query="direction" type="string">
  Direction du tri. Valeurs permises : `asc`, `desc`
</ParamField>

<ParamField query="lang" type="string">
  Langue de l'API. Valeurs permises : `en`, `fr`
</ParamField>

## Réponse

Retourne un tableau d'objets avec les champs suivants.

<ResponseField name="id" type="integer">
  ID de la campagne.
</ResponseField>

<ResponseField name="name" type="string">
  Nom de la campagne.
</ResponseField>

<ResponseField name="amount_goal" type="number">
  Montant de l'objectif.
</ResponseField>

<ResponseField name="amount_goal_formatted" type="string">
  Montant de l'objectif de la campagne, formaté avec le symbole de devise.
</ResponseField>

<ResponseField name="amount_raised" type="number">
  Montant amassé par la campagne.
</ResponseField>

<ResponseField name="amount_raised_formatted" type="string">
  Montant amassé par la campagne, formaté avec le symbole de devise.
</ResponseField>

<ResponseField name="goal_type" type="string">
  Type d'objectif de la campagne.
</ResponseField>

<ResponseField name="n_donors" type="number">
  Nombre de donateurs
</ResponseField>

<ResponseField name="n_teams" type="integer">
  Nombre d'équipes dans la campagne.
</ResponseField>

<ResponseField name="n_pages" type="integer">
  Nombre de pages personnelles dans la campagne.
</ResponseField>

<ResponseField name="url" type="string">
  URL de la campagne.
</ResponseField>

<ResponseField name="image" type="string">
  ID de l'image de la campagne.
</ResponseField>

<ResponseField name="language" type="string">
  Langue de la campagne. Valeurs permises : `en`, `fr`
</ResponseField>

<ResponseField name="is_hidden" type="boolean">
  Vrai si la campagne est masquée, sinon faux.
</ResponseField>

<ResponseField name="closed_at" type="string">
  Date de fermeture de la campagne
</ResponseField>

<ResponseField name="user" type="object">
  <Expandable title="propriétés">
    <ResponseField name="name" type="string">
      Nom du propriétaire de la campagne
    </ResponseField>

    <ResponseField name="first_name" type="string">
      Prénom du propriétaire de la campagne
    </ResponseField>

    <ResponseField name="last_name" type="string">
      Nom de famille du propriétaire de la campagne
    </ResponseField>

    <ResponseField name="title" type="string">
      Titre du propriétaire de la campagne
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="organization" type="object">
  <Expandable title="propriétés">
    <ResponseField name="id" type="integer">
      ID de l'organisation de la campagne
    </ResponseField>

    <ResponseField name="name" type="string">
      Nom de l'organisation de la campagne
    </ResponseField>

    <ResponseField name="custom_id" type="string">
      ID personnalisé de l'organisation de la campagne
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="images" type="object">
  <Expandable title="propriétés">
    <ResponseField name="original" type="string">
      URL de l'image originale de la campagne.
    </ResponseField>
  </Expandable>
</ResponseField>

**Autres réponses**

| Status | Description |
| ------ | ----------- |
| `400`  | Bad Request |
| `403`  | Forbidden   |

<ResponseExample>
  ```json theme={null}
  [
    {
      "id": 1,
      "name": "Campaign",
      "amount_goal": 1000,
      "amount_goal_formatted": "$1,000",
      "amount_raised": 550,
      "amount_raised_formatted": "$550",
      "n_donors": 10,
      "url": "https://demo.crowdchange.dev/2",
      "language": "en",
      "is_hidden": false,
      "closed_at": "2022-03-01 00:00:00",
      "user": {
        "name": "John Snow",
        "first_name": "John",
        "last_name": "Snow",
        "title": "Mr."
      },
      "organization": {
        "id": 1,
        "name": "Crowdchange",
        "custom_id": "CrowdchangeID"
      },
      "images": {
        "original": "https://img.crowdchange.co/files/abc.png?tr=w-[width],h-[height]"
      }
    }
  ]
  ```
</ResponseExample>
