Aller au contenu principal
Page non répertoriée
Cette page n'est pas répertoriée. Les moteurs de recherche ne l'indexeront pas, et seuls les utilisateurs ayant un lien direct peuvent y accéder.

Récupération des utilisateurs d'une entreprise

Description​

Récupère la liste paginée des utilisateurs actifs d'une entreprise à partir de son identifiant (companyId).


Endpoint​

GET https://api.mytalentplug.com/cust/v1/companies/{companyId}/users

Authentification​

  • Requise : Oui
  • Type : Bearer Authentication
  • Exemple d'en-tête :
Authorization: Bearer <token>

Requête​

Paramètres de route​

Nom du paramètreTypeRequisFormatExempleDescription
companyIdstringOuico_...co_123abcdIdentifiant de l'entreprise

Paramètres de query​

Nom du paramètreTypeRequisPar défautFormatExempleDescription
pageintegerNon1>= 11Numéro de la page
pageSizeintegerNon501 à 5010Nombre d'utilisateurs par page

Réponse​

La réponse est au format JSON.

Réponse 200 (succès)​

Exemple​
{
"items": [
{
"id": "usr_123abcd",
"login": "marie.dupont",
"isAdmin": false,
"displayName": "Marie D."
},
{
"id": "usr_456efgh",
"login": "paul.martin",
"isAdmin": true,
"displayName": "Paul M."
}
],
"page": 1,
"pageSize": 10,
"totalCount": 2,
"hasNextPage": false,
"hasPreviousPage": false
}
Détail des champs

Propriétés de la réponse​

ChampTypeDescription
itemsarrayListe des utilisateurs actifs de l'entreprise. Voir items.
pageintegerPage courante.
pageSizeintegerNombre d'éléments demandés par page.
totalCountintegerNombre total d'utilisateurs actifs correspondant à la demande.
hasNextPagebooleanIndique s'il existe une page suivante.
hasPreviousPagebooleanIndique s'il existe une page précédente.

Schéma items​

ChampTypeDescription
idstringIdentifiant de l'utilisateur.
loginstringLogin de l'utilisateur.
isAdminbooleanIndique si l'utilisateur est un administrateur.
displayNamestringNom affiché de l'utilisateur. Si le prénom ou le nom est absent, le login est retourné.

Réponses d'erreur​

Code HTTPMessageDescription
400Bad RequestParamètres invalides : companyId vide ou invalide, page < 1, pageSize hors intervalle 1-50
401UnauthorizedJeton d'accès manquant ou invalide
403ForbiddenAccès refusé
404Not FoundAucune entreprise ne correspond au companyId fourni
429Too Many RequestsLimite d'appels dépassée (voir Limites d'appels)
500Internal Server ErrorLe serveur a rencontré un problème inattendu

Exemple de requête avec curl​

curl -X GET 'https://api.mytalentplug.com/cust/v1/companies/co_123abcd/users?page=1&pageSize=10' \
-H 'Authorization: Bearer <token>'