> For the complete documentation index, see [llms.txt](https://docs.cootje.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cootje.com/cootje-api/uitnodigingen-onboarding/ophalen.md).

# Ophalen

Openstaande en afgeronde uitnodigingen ophalen en de voortgang volgen.

Hiermee haal je de uitnodigingen van de omgeving op en volg je of ze zijn afgerond.

* **Aanroep:** `GET /organizations/invite`
* **Vereist recht:** Personen kunnen inzien

## Verplichte velden

Geen.

## Optionele velden

| Veld        | Plek      | Toelichting                                                                                                                 |
| ----------- | --------- | --------------------------------------------------------------------------------------------------------------------------- |
| `completed` | in de URL | `true` geeft alleen de afgeronde uitnodigingen. Laat je het veld weg of geef je `false`, dan krijg je alleen de openstaande |

Eén aanroep geeft dus nooit beide groepen. Wil je alles, doe de aanroep dan twee keer.

## Voorbeeld

```bash
# Openstaande uitnodigingen
curl "https://mijn.cootje.com/api/organizations/invite" \
  -H "Authorization: Bearer JOUW_TOKEN"

# Afgeronde uitnodigingen
curl "https://mijn.cootje.com/api/organizations/invite?completed=true" \
  -H "Authorization: Bearer JOUW_TOKEN"
```

## Wat je terugkrijgt

Een lijst met uitnodigingen. Dit is een lijst met één openstaande uitnodiging:

```json
[
  {
    "_id": "8c7b6a59-4e3d-4c2b-a190-f8e7d6c5b4a3",
    "emailBody": "<p>Beste [NAME],</p><p>Lever je gegevens aan via <a href=\"[LINK_VALUE]\">deze link</a>.</p>",
    "email": "sanne@voorbeeld.nl",
    "name": "Sanne",
    "code": "a1b2c3d4",
    "environment": "voorbeeldzorg",
    "documentListId": "2d3e4f5a-6b7c-4d8e-9f0a-1b2c3d4e5f6a",
    "companyId": null,
    "type": 1,
    "registerCredentials": true,
    "isSupplier": false,
    "isCustomer": false,
    "sentAt": 1799746200000,
    "sentCount": 1,
    "requestedBy": "koppeling@voorbeeld.nl",
    "createdAt": 1799746200000,
    "completedAt": null,
    "contractDetails": null
  }
]
```

* `_id` gebruik je om de uitnodiging [opnieuw te versturen](https://docs.cootje.com/cootje-api/uitnodigingen-onboarding/opnieuw-versturen.md) of te [verwijderen](https://docs.cootje.com/cootje-api/uitnodigingen-onboarding/verwijderen.md).
* `code` is de code uit de persoonlijke link.
* `type` is de soort uitnodiging: `1` zzp, `2` tijdelijke arbeidsovereenkomst, `3` inhuur bij een bestaand bedrijf, `4` inhuur met een nieuw bedrijf.
* `sentAt`, `createdAt` en `completedAt` zijn tijdstippen in milliseconden sinds 1970. `completedAt` is `null` zolang de uitnodiging openstaat.
* `sentCount` is het aantal keren dat de e-mail is verstuurd.
* `requestedBy` is het e-mailadres van het account dat de uitnodiging het laatst heeft verstuurd.
* `contractDetails` is `null` als er bij het versturen geen conceptcontract is voorbereid.

Er is geen aanroep om één uitnodiging op kenmerk op te halen. Zoek de uitnodiging op in de lijst.

## Antwoorden

| Code  | Betekenis                                        |
| ----- | ------------------------------------------------ |
| `200` | De lijst met uitnodigingen                       |
| `401` | Geen geldig token, of het account mist het recht |
