Skip to content
Navigation

Lister les collaborateurs

Liste paginée des collaborateurs de l’entreprise, triés par nom puis prénom. Avec un filtre sur un collaborateur, une liste vide renvoie 404.

GET
https://api.puncto.fr/public/v1/collaborators

Authentification

  • bearerAuth
    HTTP
    requis

Query parameters

  • page
    optionnel
    integer

    Numéro de page, à partir de 1.

    minimum: 1 · default: 1
  • perPage
    optionnel
    integer

    Nombre d’éléments par page, 200 au plus.

    maximum: 200 · minimum: 1 · default: 50
  • collaboratorId
    optionnel
    string

    Identifiant Puncto du collaborateur. Ne pas combiner avec collaboratorForeignErpId.

  • collaboratorForeignErpId
    optionnel
    string

    Identifiant du collaborateur dans votre système (foreignErpId). Ne pas combiner avec collaboratorId.

Retour

200

Page de collaborateurs

JSON
  • data
    tableau de
    object
    requis
    • collaboratorId
      string
      requis

      Identifiant Puncto

    • companyId
      string
      requis

      Identifiant Puncto

    • establishmentId
      requis

      Établissement du contrat courant — null pour un collaborateur sans contrat

      One of the following:

      • string
      • null
    • firstName
      string
      requis
    • lastName
      string
      requis
    • usageFirstName
      string | null
      requis
    • usageLastName
      string | null
      requis
    • email
      string | null
      requis
    • phoneNumber
      string | null
      requis
    • birthDate
      string
      requis
      format: date
    • birthCity
      string
      requis
    • birthDepartmentCode
      string
      requis

      Pour les salariés nés dans les TOM : code 98

      Pour les personnes nées à l'étranger : code 99

    • birthCountryCode
      FR
      ou
      GP
      ou
      BL
      ou
      MF
      ou
      MQ
      ou
      GF
      +199 de plus
      requis
    • nationality
      FR
      ou
      GP
      ou
      BL
      ou
      MF
      ou
      MQ
      ou
      GF
      +199 de plus
      requis
    • originUeCodification
      01
      ou
      02
      ou
      03
      ou
      04
      requis
    • identity
      requis

      Identité sociale en vigueur (NIR, NIA ou NTT). Pour un collaborateur dont l'embauche n'a pas encore commencé, sa première identité, qui prend effet le 1er du mois de son entrée.

      One of the following:

      • ApiCollaboratorIdentity
        • type
          NTT
          ou
          NIA
          ou
          NIR
          requis
        • numero
          string
          requis
        • startDate
          string
          requis
          format: date
      • null
    • socialSecurityNumber
      string | null
      requis

      NIR ou NIA

    • ntt
      string | null
      requis

      NTT = NIR temporaire en l'absence de NIA

    • sex
      FEMALE
      ou
      MALE
      ou
      null
      requis

      Sexe, déduit du premier chiffre du NIR, du NIA ou du NTT (impair : homme, pair : femme). Null quand il ne peut pas en être déduit.

    • address
      object
      requis
      • id
        string
        requis

        Identifiant Puncto

      • address
        string
        requis
      • postalCode
        string
        requis
      • city
        string
        requis
      • addressDetails
        string | null
        requis
      • countryCode
        FR
        ou
        GP
        ou
        BL
        ou
        MF
        ou
        MQ
        ou
        GF
        +199 de plus
        requis
    • dependentChildrenCount
      number
      requis

      Situation familiale

    • disabledDependentChildrenCount
      number
      requis

      Parmi dependentChildrenCount, les enfants à charge handicapés

    • maritalStatus
      requis

      Null tant qu'elle n'est pas renseignée

      One of the following:

      • MaritalStatus
      • null
    • isBoeth
      boolean
      requis
    • boethStatus
      requis

      One of the following:

      • OnboardingHandicapValue
      • null
    • seniorityDate
      requis

      One of the following:

      • string
      • null
    • paymentOption
      requis

      One of the following:

      • VirementPaymentOption
        • type
          string
          requis
        • iban
          string
          requis
        • bic
          string
          requis
      • CheckPaymentOption
        • type
          string
          requis
      • CashPaymentOption
        • type
          string
          requis
    • matriculeRh
      string
      requis
    • conventionalPosition
      requis

      Position Syntec de l'avenant en vigueur du contrat courant (pour un contrat qui n'a pas encore commencé : de son premier avenant) — null sans contrat ni position

      One of the following:

      • SyntecPosition
      • null
    • coefficient
      number | null
      requis
    • foreignErpId
      string | null
      requis

      Identifiant du collaborateur dans votre système, unique dans l'entreprise

    • managerId
      requis

      Manager du collaborateur, null s'il n'en a pas

      One of the following:

      • string
      • null
    • createdAt
      string
      requis
      format: date-time
    • updatedAt
      string
      requis
      format: date-time
  • meta
    object
    requis
    • total
      integer
      requis

      Nombre total d’éléments.

    • page
      integer
      requis

      Page renvoyée.

    • perPage
      integer
      requis
    • currentPage
      integer
      requis
    • firstPage
      integer
      requis
    • lastPage
      integer
      requis

401

Clé d’API absente, invalide ou révoquée
JSON
  • error
    string
    requis

    Message lisible, en français.

  • errorCode
    optionnel
    string

    Code stable, sur certaines erreurs.

403

Opération hors de l’accès de la clé d’API
JSON
  • error
    string
    requis

    Message lisible, en français.

  • errorCode
    optionnel
    string

    Code stable, sur certaines erreurs.

404

Aucun collaborateur ne correspond au filtre
JSON
  • error
    string
    requis

    Message lisible, en français.

  • errorCode
    optionnel
    string

    Code stable, sur certaines erreurs.

422

Paramètres invalides
JSON
  • errors
    tableau de
    object
    requis
    • message
      string
      requis
    • rule
      string
      requis

      Règle de validation en échec.

    • field
      string
      requis

      Chemin du champ, par exemple absences.0.type.

Type to search…

↑↓ navigate↵ selectEsc close