Collaborateurs - liste
  • 23 Apr 2023
  • 1 Minute to read
  • Dark
    Light
  • PDF

Collaborateurs - liste

  • Dark
    Light
  • PDF

Article summary

Post
/api/V1/collaborators

Retourne la liste des salariés qu'un utilisateur peut voir

Header parameters
Authorization
string

Bearer ...token jwt...

X-UserArea-Type
string

Type (collaborator, manager, etc) de l'espace utilisateur à utiliser.

X-UserArea-Id
string

Identifiant de l'espace utilisateur à utiliser

Body parameters

Expand All

object

filters
Array of object  Required 


object

_type
string 

Valid values["CollaboratorFilter"]
name
string   Required 

Valid values["company_id","globalSearch"]
criteria
object  Required 

_type
string   Required 

Valid values["StringValue"]
value
string   Required 

Valid values["1"]
offset
number   Required 

Valid values["0"]
limit
number   Required 

Valid values["200"]
sort
object  Required 

field
string   Required 

Valid values["firstname"]
direction
string   Required 

Valid values["ASC","DESC"]
Responses
200

OK

Expand All

object

status
string 

Valid values["ok"]
Min length1
data
object

pagination
object

offset
number 


limit
number 


total
number 


current_page
number 


total_pages
number 


collaborators
Array of object


object

id
number 

Valid values["910"]
first_name
string 

Valid values["Georges"]
last_name
string 

Valid values["ABITBOL"]
start_hire_date
string 

Valid values["2020-01-01T00:00:00+00:00"]
end_hire_date
string 

Valid values["2020-07-01T00:00:00+00:00"]
details_url
string 

Valid values["https://mon-rh.silaerh.pro"]
teams
object

20
string 

Valid values["Equipe logistique"]
contracts
Array of object


object

id
number 

Valid values["1314"]
updated_at
string 

Valid values["2020-08-13T12:19:32+00:00"]
start_hire_date
string 

Valid values["2020-01-01T00:00:00+00:00"]
end_hire_date
string 

Valid values["2020-07-01T00:00:00+00:00"]
matricule
number 

Valid values["101"]
site
object


poste
object


taux_horaire
number 

Valid values["0"]
actif
boolean 

Valid values["False","True"]
managers
object


date_naissance
string 

Valid values["1970-01-01T00:00:00+00:00"]
updated_at
string 

Valid values["2020-08-13T12:19:32+00:00"]
genre
string 

Valid values["project.user.admin.fields.genre.femme"]
matricule
number 

Valid values["101"]
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

example-2
{
  "status": "ko",
  "errors": [
    {
      "type": "TechnicalError",
      "technicalErrorId": "4ad086ee-2e3f-408a-bf16-2dc184b134cf"
    }
  ]
}
Expand All

object

status
string 

Valid values["ko","ok"]
errors
Array of object


object

type
string 

Valid values["TechnicalError"]
Min length1
technicalErrorId
string 

Min length1

Was this article helpful?