Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Hier vind je de stappen om (alle) gebruikers uit het systeem op te halen. Dit endpoint wordt gebruikt om de lijst van (alle) gebruikers die beschikbaar zijn in het systeem op te halen, samen met hun eigenschappen. Alleen de Admin-rol in BlueDolphin kan andere gebruikers uit het systeem ophalen.
HTTP-responses
HTTP response status code | Interpretatie |
200 OK | Gebruikers succesvol opgehaald |
400 Bad Request | Eén of meer parameters ontbreken of zijn onjuist. De response body geeft een specifieke foutmelding terug:
|
401 Unauthorized | Ongeldige of ontbrekende API key secret en/of tenant |
403 Forbidden | De gebruiker heeft geen adminrechten |
Om de lijst met gebruikers in je tenant op te halen, doe je een GET-verzoek naar het /users[?start_with={start}&take={take}&include_guests={include_guests}] endpoint met de volgende specificaties:
Bedrijfsmiddel/endpoint bestemmings-URL. Je kunt ervoor kiezen om een verzoek te sturen voor een volledige lijst, of optioneel parameters instellen in de request-URI om een gefilterde lijst van gebruikers op te halen.
Parameter | Vereist | Type | Standaard | Beschrijving |
start_with | X | string |
| Unieke identificatie voor de gebruiker die in de huidige response wordt teruggegeven |
take | X | nummer (0 of positief) | 100 | Het aantal gebruikers dat wordt teruggegeven |
include_guests | X | boolean | false | Als deze op true staat, worden gastgebruikersaccounts meegenomen in de response. |
De header voor je API-verzoek
Om de gefilterde lijst met gebruikers in onze BlueDolphin-tenant op te halen, waarbij we 3 gebruikers ophalen vanaf het ID 59e43775d51a8afb7d9433ab, sturen we een GET-verzoek naar de URI https://public-api.eu.bluedolphin.app/v1/users?start_with=59e43775d51a8afb7d9433ab&take=3.
curl -L 'https://public-api.eu.bluedolphin.app/v1/users?start_with=59e43775d51a8afb7d9433ab&take=3' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json'
Response-eigenschappen
Eigenschap | Type | Beschrijving |
total_items | nummer | Het aantal teruggegeven gebruikers. Dit kan worden vergeleken met |
users | array | Gebruikersinformatie |
users[].id | string | Unieke identificatie voor de gebruiker |
users[].first_name | string | De voornaam van de gebruiker |
users[].last_name | string | De achternaam van de gebruiker |
users[].is_guest_user | boolean | Geeft aan of de gebruiker een gastgebruiker is |
Een geslaagde call geeft een response terug met een 200 OK HTTP-statuscode en de volgende body:
{ "total_items": 3, "users": [ { "id": "59e43775d51a8afb7d9433ab", "first_name": "Jane", "last_name": "Smith", "is_guest_user": false }, { "id": "59e43775d51a8afb7d943300", "first_name": "John", "last_name": "Blake", "is_guest_user": false }, { "id": "59e43775d51a8afb7d943330", "first_name": "Hanna", "last_name": "Wright", "is_guest_user": false } ]}