Récupération des entreprises d'un utilisateur
Description
Récupère la liste paginée des entreprises auxquelles un utilisateur a accès.
Endpoint
GET https://api.mytalentplug.com/cust/v1/users/{userId}/companies
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 |
|---|---|---|---|---|---|
userId | string | Oui | usr_... | usr_123abcd | Identifiant de l'utilisateur |
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'éléments par page |
Réponse
La réponse est au format JSON.
Réponse 200 (succès)
Exemple
{
"companies": [
{
"id": "co_123abcd",
"name": "Entreprise Alpha"
},
{
"id": "co_456efgh",
"name": "Filiale Beta"
}
],
"page": 1,
"pageSize": 10,
"totalCount": 2,
"hasNextPage": false,
"hasPreviousPage": false
}
Détail des champs
Propriétés de la réponse
| Champ | Type | Description |
|---|---|---|
companies | array | Liste des entreprises accessibles par l'utilisateur. Voir companies. |
page | integer | Numéro de la page actuelle. |
pageSize | integer | Nombre d'éléments renvoyés dans la page. |
totalCount | integer | Nombre total d'éléments toutes pages confondues. |
hasNextPage | boolean | Indique s'il existe une page suivante. |
hasPreviousPage | boolean | Indique s'il existe une page précédente. |
Schéma companies
| Champ | Type | Nullable | Description |
|---|---|---|---|
id | string | Non | Identifiant de l'entreprise. |
name | string | Non | Raison sociale de l'entreprise. |
Réponses d'erreur
| Code HTTP | Message | Description |
|---|---|---|
400 | Bad Request | Paramètre invalide (ex. : userId n'est pas un UUID valide, pageSize hors de la plage 1–50) |
401 | Unauthorized | Jeton d'accès manquant ou invalide |
403 | Forbidden | Accès refusé — l'utilisateur n'appartient pas à l'entreprise du partenaire |
404 | Not Found | L'utilisateur identifié par userId n'existe pas |
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
{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"title": "Bad Request",
"status": 400,
"detail": "Validation failed: \n -- PageSize: must be between 1 and 50 Severity: Error",
"traceId": "0HNB7RMJ268SM:00000003",
"requestId": "00-19aae3969015288f7162ad681f003a16-af9a7edd53036350-00"
}
Exemple de requête avec curl
curl -X GET 'https://api.mytalentplug.com/cust/v1/users/22CDFCBF-34C6-40E1-84DA-35181918F07A/companies?page=1&pageSize=10' \
-H 'Authorization: Bearer <token>'