Factuarea APIDevelopers

Llistar tots els empleats

Llista els empleats de la teva empresa amb paginació per cursor.

Admet filtrar per status (active/inactive), employment_type (full_time/part_time) i ccaa, més una search de text lliure sobre nom i email.

GET
/employees
AuthorizationBearer <token>

A: header

Paràmetres de consulta

limit?integer

Nombre d'objectes a retornar. Enter entre 1 i 100. Per defecte 25.

Predeterminat25
Rang1 <= value <= 100
starting_after?string

Cursor per a paginació cap endavant. Fes servir l'uuid de l'últim objecte de la pàgina anterior.

Formatuuid
ending_before?string

Cursor per a paginació cap enrere. Fes servir l'uuid del primer objecte de la pàgina actual.

Formatuuid
status?string

Estat de l'empleat. Coincidència exacta amb status.

Valor a"active" | "inactive"
status[in]?string

Estat de l'empleat. Llista separada per comes. Coincideix qualsevol dels valors.

employment_type?string

Tipus de contracte laboral. Coincidència exacta amb employment_type.

Valor a"full_time" | "part_time"
employment_type[in]?string

Tipus de contracte laboral. Llista separada per comes. Coincideix qualsevol dels valors.

ccaa?string

Codi de comunitat autònoma espanyola (ISO 3166-2:ES) de l'empleat. Coincidència exacta amb ccaa.

ccaa[in]?string

Codi de comunitat autònoma espanyola (ISO 3166-2:ES) de l'empleat. Llista separada per comes. Coincideix qualsevol dels valors.

search?string

Cerca de text lliure. LIKE %term% escapat (sense distingir majúscules, màx. 80 caràcters) sobre les columnes de text clau del recurs, combinat amb la resta de filtres (AND) i compatible amb el cursor.

Longitudlength <= 80

Headers

Factuarea-Version?string

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate
X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

application/json