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ètre | Type | Requis | Format | Exemple | Description |
|---|---|---|---|---|---|
companyId | string | Oui | co_... | co_123abcd | Identifiant de l'entreprise |
Paramètres de query
| Nom du paramètre | Type | Requis | Par défaut | Format | Exemple | Description |
|---|---|---|---|---|---|---|
page | integer | Non | 1 | >= 1 | 1 | Numéro de la page |
pageSize | integer | Non | 50 | 1 à 50 | 10 | Nombre 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
| Champ | Type | Description |
|---|---|---|
items | array | Liste des utilisateurs actifs de l'entreprise. Voir items. |
page | integer | Page courante. |
pageSize | integer | Nombre d'éléments demandés par page. |
totalCount | integer | Nombre total d'utilisateurs actifs correspondant à la demande. |
hasNextPage | boolean | Indique s'il existe une page suivante. |
hasPreviousPage | boolean | Indique s'il existe une page précédente. |
Schéma items
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant de l'utilisateur. |
login | string | Login de l'utilisateur. |
isAdmin | boolean | Indique si l'utilisateur est un administrateur. |
displayName | string | Nom affiché de l'utilisateur. Si le prénom ou le nom est absent, le login est retourné. |
Réponses d'erreur
| Code HTTP | Message | Description |
|---|---|---|
400 | Bad Request | Paramètres invalides : companyId vide ou invalide, page < 1, pageSize hors intervalle 1-50 |
401 | Unauthorized | Jeton d'accès manquant ou invalide |
403 | Forbidden | Accès refusé |
404 | Not Found | Aucune entreprise ne correspond au companyId fourni |
429 | Too Many Requests | Limite d'appels dépassée (voir Limites d'appels) |
500 | Internal Server Error | Le 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>'