> ## 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.

# Rechercher une campagne

> Recherchez des campagnes CrowdChange côté serveur avec des filtres avancés et récupérez une liste paginée avec objectif, montant amassé et statut.

## Paramètres du corps

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

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

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

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

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

<ParamField body="email" type="string">
  Filtre par courriel.
</ParamField>

<ParamField body="status" type="string">
  Statut de la campagne. Valeurs permises : `approved`, `pending`
</ParamField>

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

<ParamField body="created_at" type="object">
  Filtre sur la date de création de la campagne.

  <Expandable title="propriétés">
    <ParamField body="<" type="string" />

    <ParamField body="<=" type="string" />

    <ParamField body="=" type="string" />

    <ParamField body=">=" type="string" />

    <ParamField body=">" type="string" />
  </Expandable>
</ParamField>

<ParamField body="amount_goal" type="object">
  Filtre sur le montant de l'objectif de la campagne.

  <Expandable title="propriétés">
    <ParamField body="<" type="number" />

    <ParamField body="<=" type="number" />

    <ParamField body="=" type="number" />

    <ParamField body=">=" type="number" />

    <ParamField body=">" type="number" />
  </Expandable>
</ParamField>

<ParamField body="amount_raised" type="object">
  Filtre sur le montant amassé par la campagne.

  <Expandable title="propriétés">
    <ParamField body="<" type="number" />

    <ParamField body="<=" type="number" />

    <ParamField body="=" type="number" />

    <ParamField body=">=" type="number" />

    <ParamField body=">" type="number" />
  </Expandable>
</ParamField>

<ParamField body="after_id" type="integer">
  Retourne les équipes après cet identifiant d'équipe.
</ParamField>

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

<ParamField body="filter_by_lang" type="integer">
  Filtre les campagnes disponibles uniquement dans cette langue
</ParamField>

<ParamField body="tags" type="string[]">
  Liste des étiquettes de la campagne.
</ParamField>

## Réponse

Retourne un tableau d'objets contenant les champs suivants.

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

<ResponseField name="partner_id" type="integer">
  Identifiant du site.
</ResponseField>

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

<ResponseField name="created_at" type="string">
  Date de création de la campagne.
</ResponseField>

<ResponseField name="amount_goal" type="number">
  Montant de l'objectif.
</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="dt_start" type="string">
  Date et heure de début de la campagne.
</ResponseField>

<ResponseField name="dt_end" type="string">
  Date et heure de fin de la campagne.
</ResponseField>

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

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

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

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

<ResponseField name="n_pages" type="integer">
  Nombre de pages.
</ResponseField>

<ResponseField name="status" type="string">
  Statut d'approbation de la campagne. Valeurs permises : `approved`, `pending`
</ResponseField>

<ResponseField name="status_code" type="string">
  Code de statut d'activité de la campagne. Valeurs permises : `live`, `deleted`, `archived`, `pending_approval`, `opening_soon`, `closed`
</ResponseField>

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

<ResponseField name="auto_open_at" type="string">
  Date à laquelle la campagne est programmée pour s'ouvrir automatiquement
</ResponseField>

<ResponseField name="auto_close_at" type="string">
  Date à laquelle la campagne est programmée pour se fermer automatiquement
</ResponseField>

<ResponseField name="closed_at" type="string">
  Date à laquelle la campagne a été fermée
</ResponseField>

<ResponseField name="archived_at" type="string">
  Date à laquelle la campagne a été archivée
</ResponseField>

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

<ResponseField name="in_support_name" type="string">
  Valeur du champ `In support of` (« au profit de ») associé à la campagne.
</ResponseField>

<ResponseField name="in_support_code" type="string">
  Code fourni pour le champ `In support of` (« au profit de »).
</ResponseField>

<ResponseField name="appeal_code" type="string">
  Code d'appel.
</ResponseField>

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

    <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>

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

<ResponseField name="organization" type="object">
  <Expandable title="propriétés">
    <ResponseField name="id" type="integer">
      Identifiant 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">
      Identifiant personnalisé de l'organisation de la campagne
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="fundraiser_template" type="object">
  <Expandable title="propriétés">
    <ResponseField name="id" type="integer">
      Identifiant du modèle.
    </ResponseField>

    <ResponseField name="name" type="string">
      Nom du modèle.
    </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>

<ResponseField name="custom_data" type="object[]">
  Liste des questions personnalisées et de leurs réponses.

  <Expandable title="propriétés">
    <ResponseField name="field_id" type="integer">
      Identifiant du champ personnalisé.
    </ResponseField>

    <ResponseField name="source_id" type="integer">
      Si le champ a été copié depuis un Blueprint, ceci référence l'identifiant du champ source dans le Blueprint (similaire à un identifiant de groupe).
    </ResponseField>

    <ResponseField name="name" type="string">
      Libellé du champ personnalisé.
    </ResponseField>

    <ResponseField name="content" type="string">
      Réponse de l'utilisateur au champ personnalisé.
    </ResponseField>

    <ResponseField name="field_custom_id" type="string">
      Identifiant personnalisé.
    </ResponseField>

    <ResponseField name="response_custom_id" type="string">
      Identifiant personnalisé pour la réponse (questions à choix multiples).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="tags_list" type="any[]">
  Étiquettes de la campagne.
</ResponseField>

**Autres réponses**

| Statut | Description      |
| ------ | ---------------- |
| `400`  | Requête invalide |
| `403`  | Interdit         |

<ResponseExample>
  ```json theme={null}
  [
    {
      "id": 1,
      "partner_id": 10,
      "name": "Campaign",
      "created_at": "2022-01-01 16:00:03",
      "amount_goal": 1000,
      "amount_raised": 550,
      "amount_raised_formatted": "$550",
      "dt_start": "2021-01-01 08:00:00",
      "dt_end": "2021-01-01 16:00:00",
      "location": "100 Main Street, Toronto, ON",
      "url": "https://demo.crowdchange.dev/2",
      "n_donors": 100,
      "n_teams": 50,
      "n_pages": 50,
      "status": "approved",
      "status_code": "approved",
      "is_hidden": false,
      "auto_open_at": "2022-03-01 00:00:00",
      "auto_close_at": "2022-03-01 00:00:00",
      "closed_at": "2022-03-01 00:00:00",
      "archived_at": "2022-03-01 00:00:00",
      "language": "en",
      "in_support_name": "Cancer Research",
      "in_support_code": "CR-123",
      "appeal_code": "GEN-123",
      "user": {
        "id": 1,
        "name": "John Snow",
        "first_name": "John",
        "last_name": "Snow",
        "title": "Mr.",
        "email": "john@crowdchange.co"
      },
      "organization": {
        "id": 1,
        "name": "Crowdchange",
        "custom_id": "CrowdchangeID"
      },
      "fundraiser_template": {
        "id": 1,
        "name": "Template"
      },
      "images": {
        "original": "https://img.crowdchange.co/files/abc.png?tr=w-[width],h-[height]"
      },
      "custom_data": [
        {
          "field_id": 1001,
          "source_id": 11,
          "name": "Phone Number",
          "content": "555-123-4567",
          "field_custom_id": "ABC-123",
          "response_custom_id": "ABC-123"
        }
      ],
      "tags_list": [
        "tag1",
        "tag2"
      ]
    }
  ]
  ```
</ResponseExample>