### GET /v2/working-times/projects/customers Source: https://api.hrworks.de/v2/openapi.yaml Returns a list of time tracking project customers. ```markdown ### Parameters - **onlyActive** (boolean, query, optional): Set this parameter to false to also receive inactive project customers ### Responses #### 200 - successful operation **GetTimeTrackingProjectCustomersResponse** - **customers** (array (TimeTrackingProjectCustomer)) Array items: - **id** (string): The unique identifier of the customer. - **number** (string): The customer number. - **name** (string): Name of the customer. - **isActive** (boolean): Indicates whether the customer is currently in use. - **activeProjectCount** (number): The number of active projects of the customer. - **totalProjectCount** (number): The number of projects of the customer. #### default - Error payload. See #/responses for a list of general API errors. **ApiError** - **errorCode** (number): The HTTP error code, e.g. 403. - **type** (string): A string identifier for the error, e.g. InvalidCredentialsError - **errorMessage** (string): A text description of the error. Refer to this description in order to identify a solution for the problem. - **additionalErrors** (array (ApiError)): Sub-errors that might be attached to the main error object. Array items: ### Example Usage ```bash curl -X GET "https://api.hrworks.de/v2/working-times/projects/customers?onlyActive=true" ``` ``` -------------------------------- ### GET /v2/wage-and-salary/types Source: https://api.hrworks.de/v2/openapi.yaml Returns all wage types. ```markdown ### Parameters - **onlyActive** (boolean, query, optional): Boolean parameter to decide if only active wage types should be returned. ### Responses #### 200 - successful operation **ListWageAndSalaryTypesResponse** - **wageAndSalaryTypes** (array (WageType)) Array items: - **number** (number): The wage type number. - **isActive** (boolean) - **exportKey** (string) - **type** (string (systemWageType|customWageType)): Shows if the wage type is custom or a preconfigured wage type (systemWageType). ("systemWageType"|"customWageType") - **name** (string) - **internationalCountryCode** (string) - **importKey** (string) #### default - Error payload. See #/responses for a list of general API errors. **ApiError** - **errorCode** (number): The HTTP error code, e.g. 403. - **type** (string): A string identifier for the error, e.g. InvalidCredentialsError - **errorMessage** (string): A text description of the error. Refer to this description in order to identify a solution for the problem. - **additionalErrors** (array (ApiError)): Sub-errors that might be attached to the main error object. Array items: ### Example Usage ```bash curl -X GET "https://api.hrworks.de/v2/wage-and-salary/types?onlyActive=true" ``` ``` -------------------------------- ### GET /v2/applicant-management/posts Source: https://api.hrworks.de/v2/openapi.yaml List all posts of the company. ```markdown ### Parameters - **onlyActive** (boolean, query, optional): Set this parameter to either return only active posts (true) or all posts (false). The default value is true ### Responses #### 200 - successful operation **ListPostsResponse** - **posts** (array (Post)) Array items: - **displayName** (string): The name of the post, to be displayed in a job portal. - **name** (string): The name of the post. - **key** (string): The unique key of the post. - **uuid** (string): The unique identifier of the post. This identifier does not change. - **organizationUnitNumber** (string): The number of the organization unit, the post belongs to. - **organizationUnitUuid** (string): The unique identifier of the organization unit the post belongs to. - **contactInformation** (object) - **contactPerson** (object) - **externalIds** (array (ExternalId)): The ids of the person in external systems. Array items: - **externalSystem** (string): The external system this id belongs to. - **id** (string): The value of the id. - **firstName** (string): The given name of the person. - **lastName** (string): The surname of the person. - **personId** (string): The HR WORKS username of the person. - **personnelNumber** (string): The personnel number of the person. - **personIdentifierForKiosk** (string): The person identifier for kiosk of the person. - **datevPersonnelNumber** (string): The DATEV personnel number of the person. This attribute is only returned if the DATEV integration is active. - **uuid** (string): The unique identifier of the person in HR WORKS. This identifier does not change. - **phone** (string): The telephone number to contact. - **email** (string): The email address to contact. - **scopeOfActivities** (string): The translated scope of activities of the post. - **scopeOfActivitiesKey** (string (administration|analysisAndStatistics|consulting|customerService|engineeringAndTechnical|financeAccountingAndControlling|graphicDesignAndArchitecture|healthMedicalAndSocial|hr|itAndSoftwareDevelopment|legal|managementAndCorporateDevelopment|marketingAndAdvertising|notSpecified|otherDisciplines|prAndJournalism|processPlanningAndQa|productionAndManufacturing|productManagement|projectManagement|purchasingMaterialsManagementAndLogistics|salesAndCommerce|researchAndDevelopment)): The unique key of the scope of activities of the post. ("administration"|"analysisAndStatistics"|"consulting"|"customerService"|"engineeringAndTechnical"|"financeAccountingAndControlling"|"graphicDesignAndArchitecture"|"healthMedicalAndSocial"|"hr"|"itAndSoftwareDevelopment"|"legal"|"managementAndCorporateDevelopment"|"marketingAndAdvertising"|"notSpecified"|"otherDisciplines"|"prAndJournalism"|"processPlanningAndQa"|"productionAndManufacturing"|"productManagement"|"projectManagement"|"purchasingMaterialsManagementAndLogistics"|"salesAndCommerce"|"researchAndDevelopment") - **isActive** (boolean): Specifies if the post is set to active. - **postImageUrl** (string): The S3-URL of the cover image assigned to the post. - **postDescriptions** (object): Description texts of a post. Used in applicant management endpoints. - **introduction** (object) - **title** (string) - **description** (string) - **tasks** (object) - **profile** (object) - **offer** (object) - **summary** (object) - **postOffers** (array (PostOffer)) Array items: - **id** (string): The ID of the postOffer. - **postOfferNameSuffix** (string): The post offer name suffix to show after the display name of the post. - **permanentEstablishments** (array (PermanentEstablishment)) Array items: - **id** (string) - **name** (string) - **address** (object) - **additionalData** (string): Additional data attached to the address, e.g. c/o information. - **city** (string): The city/town associated with the address. - **country** (string): The locale-specific name of the address country, e.g. Germany. - **fax** (string): The fax number associated with the address. Only returned for addresses of permanent establishments. - **internationalCountryCode** (string): The address country code. Given as a 3-digit country code, e.g. DEU. - **phone** (string): The phone number associated with the address. - **state** (string): The ISO 3166-2 ID of the country member state, e.g. DE-BW. - **street** (string): The street associated with the address. - **streetNumber** (string): The street number. - **zipCode** (string): The postal code of the address. - **number** (string): The eight-digit identification number of the permanent establishment. - **placeOfWorkType** (string): The translated place of work type of the post offer, e.g. 'hybrid'. - **placeOfWorkTypeKey** (string (hybrid|onsite|remote)): The unique key of the place of work type of the post offer. ("hybrid"|"onsite"|"remote") - **employmentContract** (string): The translated employment contract type of the post offer. - **employmentContractKey** (string (notSpecified|apprenticeship|externalEmployee|internship|marginalEmployment|permanentEmployment|shortTermEmployment|studentJob)) ("notSpecified"|"apprenticeship"|"externalEmployee"|"internship"|"marginalEmployment"|"permanentEmployment"|"shortTermEmployment"|"studentJob") - **careerLevel** (string): The career level of the post offer, e.g. 'Professional'. - **careerLevelKey** (string (notSpecified|apprenticeOrWorkingStudent|executive|manager|professional|seniorExecutive|youngProfessional)) ("notSpecified"|"apprenticeOrWorkingStudent"|"executive"|"manager"|"professional"|"seniorExecutive"|"youngProfessional") - **description** (string): Description of the post offer. - **displayName** (string): The name of the post offer to display in job portals. - **jobPortal** (string): Given job portal of the post offer. - **priority** (number): The priority of the post offer. - **publicationDate** (string (date)): The date on which the post offer should be published. Date in YYYY-MM-DD format. - **validUntilDate** (string (date)): The date after which the post offer expires. Only present, if the visibility of the offer is set to a limited period of time. Date in YYYY-MM-DD format. - **workingTimeModel** (string): The translated name of the working time model of the post offer. - **workingTimeModelKey** (string (notSpecified|fullTime|fullTimeOrPartTime|partTime)) ("notSpecified"|"fullTime"|"fullTimeOrPartTime"|"partTime") - **isActive** (boolean): Specifies if the post offer is set to active. - **howDidYouHearAboutUsOptions** (object) - **en** (array (string)): All possible english options that describe how the applicant became aware of the post/company. - **de** (array (string)): All possible german options that describe how the applicant became aware of the post/company. #### default - Error payload. See #/responses for a list of general API errors. **ApiError** - **errorCode** (number): The HTTP error code, e.g. 403. - **type** (string): A string identifier for the error, e.g. InvalidCredentialsError - **errorMessage** (string): A text description of the error. Refer to this description in order to identify a solution for the problem. - **additionalErrors** (array (ApiError)): Sub-errors that might be attached to the main error object. Array items: ### Example Usage ```bash curl -X GET "https://api.hrworks.de/v2/applicant-management/posts?onlyActive=true" ``` ``` -------------------------------- ### GET /v2/applicant-management/job-applications Source: https://api.hrworks.de/v2/openapi.yaml List all job applications with the specified status and post. ```markdown ### Parameters - **page** (integer, query, optional): Set this parameter to access a specific page of results. If the parameter is not set, the first page of results is returned. The API returns paging information via the Link header. The page size for this API call is 50. - **posts** (array (string), query, optional): The IDs of the posts for which to return job applications. - **statusFilter** (array (JobApplicationStatus), query, optional): The status identifiers for which to return job applications. ### Responses #### 200 - successful operation **ListJobApplicationsResponse** - **jobApplications** (array (JobApplication)) Array items: - **id** (string): The ID of the job application. - **statusIdentifier** (string (applied|employed|inProgress|movedToTalentPool|notEmployed|documentCreation)): Status identifier for job application statuses ("applied"|"employed"|"inProgress"|"movedToTalentPool"|"notEmployed"|"documentCreation") - **postUuid** (string): The unique idenifier of the post. - **applicant** (object): The applicant of a job application. - **address** (object) - **additionalData** (string): Additional data attached to the address, e.g. c/o information. - **city** (string): The city/town associated with the address. - **country** (string): The locale-specific name of the address country, e.g. Germany. - **fax** (string): The fax number associated with the address. Only returned for addresses of permanent establishments. - **internationalCountryCode** (string): The address country code. Given as a 3-digit country code, e.g. DEU. - **phone** (string): The phone number associated with the address. - **state** (string): The ISO 3166-2 ID of the country member state, e.g. DE-BW. - **street** (string): The street associated with the address. - **streetNumber** (string): The street number. - **zipCode** (string): The postal code of the address. - **birthday** (string (date)): The birthday date of the applicant. Date in format YYYY-MM-DD. - **earliestPossibleJoinDate** (string (date)): The earliest possible join date of the applicant. Date in format YYYY-MM-DD. - **email** (string): The email address of the applicant. - **firstName** (string): The first name of the applicant. - **gender** (string (male|female|diverse|not specified)) ("male"|"female"|"diverse"|"not specified") - **uuid** (string): The unique identifier of the person in HR WORKS. This identifier does not change, when the applicant is converted to an employee person. - **hasNoticePeriod** (boolean): Specifies whether the applicant has a notice period at his old position. - **isActive** (boolean): Indicates whether the applicant has an active job application. - **isSeverelyDisabled** (boolean): Specifies wether the applicant has a severely disability. - **jobApplications** (array (BaseJobApplication)) Array items: - **id** (string): The ID of the job application. - **statusIdentifier** (string (applied|employed|inProgress|movedToTalentPool|notEmployed|documentCreation)): Status identifier for job application statuses ("applied"|"employed"|"inProgress"|"movedToTalentPool"|"notEmployed"|"documentCreation") - **postUuid** (string): The unique idenifier of the post. - **languageCode** (string): The language code of the applicant. - **lastAnnualSalary** (object) - **currency** (string): The code of the currency. - **value** (string): The monetary value with up to 2 decimals. - **lastName** (string): The surname of the applicant. - **noticePeriodTimeAmount** (integer): Time amount of the notice period, unit is defined by noticePeriodTimeUnit. - **noticePeriodTimeReference** (string): The point in time, the notice period of the applicant references to. - **noticePeriodTimeUnit** (string (days|weeks|months)) ("days"|"weeks"|"months") - **salutation** (string (mr|ms|none)): The salutation of the descripted person ("mr"|"ms"|"none") - **title** (string): A honorific used by the person, e.g. "Dr.". - **placeOfBirth** (string): The city/location where the applicant was born. - **fieldOfStudy** (string): The subject the applicant has studied. - **applicationDocuments** (array (string)) - **creationDateAndTime** (string (date-time)): The creation date and time as ISO8601 string, formatted as YYYYMMDD"T"HHMMSS"Z" (example: "20250228T094600Z") - **desiredSalary** (string): The desired salary in Euro of the job application. - **howDidYouHearAboutUs** (string): A custom or predefined value that describes how the applicant became aware of the post/company. - **ipAddress** (string (ipv4)): The IP-Address of the job application creator. - **mayBePassedWithinCorporateGroup** (boolean): Specifies if the application is allowed to be passed within the whole corporate group. - **permissionToStoreApplication** (string (notGranted|onlyForApplication|afterApplication)): Describes if and how long an application is allowed to be stored. ("notGranted"|"onlyForApplication"|"afterApplication") - **postId** (string): The ID of the post the job application belongs to. - **postOfferId** (string): The ID of the post offer the application belongs to. - **remark** (string): The remark of the job application. - **status** (string): The status of the job application. - **userAgent** (string): The user agent of the job application creator. - **hasPrivacyTermsAccepted** (boolean): Specifies if the applicant accepted the privacy terms. #### default - Error payload. See #/responses for a list of general API errors. **ApiError** - **errorCode** (number): The HTTP error code, e.g. 403. - **type** (string): A string identifier for the error, e.g. InvalidCredentialsError - **errorMessage** (string): A text description of the error. Refer to this description in order to identify a solution for the problem. - **additionalErrors** (array (ApiError)): Sub-errors that might be attached to the main error object. Array items: ### Example Usage ```bash curl -X GET "https://api.hrworks.de/v2/applicant-management/job-applications?page=1&posts=item1,item2&statusFilter=item1,item2" ``` ``` -------------------------------- ### GET /v2/applicant-management/applicants Source: https://api.hrworks.de/v2/openapi.yaml Returns a list of applicants. Only applicants with job applications are returned. ```markdown ### Parameters - **applicants** (array (string), query, optional): The UUIDs of the applicants to display data for. - **statusFilter** (array (JobApplicationStatus), query, optional): If set, only applicants with a job application in the specified status will be returned. - **page** (number, query, optional): Set this parameter to access a specific page of results. If the parameter is not set, the first page of results is returned. The API returns paging information via the Link header. The page size for this API call is 50. ### Responses #### 200 - successful operation **ListApplicantsResponse** - **applicants** (array (Applicant)) Array items: - **address** (object) - **additionalData** (string): Additional data attached to the address, e.g. c/o information. - **city** (string): The city/town associated with the address. - **country** (string): The locale-specific name of the address country, e.g. Germany. - **fax** (string): The fax number associated with the address. Only returned for addresses of permanent establishments. - **internationalCountryCode** (string): The address country code. Given as a 3-digit country code, e.g. DEU. - **phone** (string): The phone number associated with the address. - **state** (string): The ISO 3166-2 ID of the country member state, e.g. DE-BW. - **street** (string): The street associated with the address. - **streetNumber** (string): The street number. - **zipCode** (string): The postal code of the address. - **birthday** (string (date)): The birthday date of the applicant. Date in format YYYY-MM-DD. - **earliestPossibleJoinDate** (string (date)): The earliest possible join date of the applicant. Date in format YYYY-MM-DD. - **email** (string): The email address of the applicant. - **firstName** (string): The first name of the applicant. - **gender** (string (male|female|diverse|not specified)) ("male"|"female"|"diverse"|"not specified") - **uuid** (string): The unique identifier of the person in HR WORKS. This identifier does not change, when the applicant is converted to an employee person. - **hasNoticePeriod** (boolean): Specifies whether the applicant has a notice period at his old position. - **isActive** (boolean): Indicates whether the applicant has an active job application. - **isSeverelyDisabled** (boolean): Specifies wether the applicant has a severely disability. - **jobApplications** (array (BaseJobApplication)) Array items: - **id** (string): The ID of the job application. - **statusIdentifier** (string (applied|employed|inProgress|movedToTalentPool|notEmployed|documentCreation)): Status identifier for job application statuses ("applied"|"employed"|"inProgress"|"movedToTalentPool"|"notEmployed"|"documentCreation") - **postUuid** (string): The unique idenifier of the post. - **languageCode** (string): The language code of the applicant. - **lastAnnualSalary** (object) - **currency** (string): The code of the currency. - **value** (string): The monetary value with up to 2 decimals. - **lastName** (string): The surname of the applicant. - **noticePeriodTimeAmount** (integer): Time amount of the notice period, unit is defined by noticePeriodTimeUnit. - **noticePeriodTimeReference** (string): The point in time, the notice period of the applicant references to. - **noticePeriodTimeUnit** (string (days|weeks|months)) ("days"|"weeks"|"months") - **salutation** (string (mr|ms|none)): The salutation of the descripted person ("mr"|"ms"|"none") - **title** (string): A honorific used by the person, e.g. "Dr.". - **placeOfBirth** (string): The city/location where the applicant was born. - **fieldOfStudy** (string): The subject the applicant has studied. ### Example Usage ```bash curl -X GET "https://api.hrworks.de/v2/applicant-management/applicants?applicants=item1,item2&statusFilter=item1,item2&page=1" ``` ``` -------------------------------- ### GET /v2/persons/{personIdentifier}/personnel-file Source: https://api.hrworks.de/v2/openapi.yaml Returns the personnel file entries of the specified person. ```markdown ### Parameters - **personIdentifierType** (PersonIdentifierType, query, optional): Specifies the type of the personIdentifier. Default is personnelNumber. - **personIdentifier** (string, path, required): The identifier of the person to display data for. Use personIdentifierType to specify what type the value is. - **category** (string, query, optional): The key of the personnel file entry category to filter the result by. - **hasDocuments** (boolean, query, optional): Allows filtering for personnel file entries with/without attached PDF documents. - **isWageRelevant** (boolean, query, optional): Allows filtering for personnel file entries being (not) wage relevant. - **createdAfter** (string (date), query, optional): Allows filtering for personnel file entries that were created on or after the specified date. Date in YYYY-MM-DD format. - **createdBefore** (string (date), query, optional): Allows filtering for personnel file entries that were created on or before the specified date. Date in YYYY-MM-DD format. ### Responses #### 200 - successful operation **ListPersonPersonnelFileEntriesResponse** - **personnelFileEntries** (array (PersonnelFileEntry)) Array items: - **category** (object): Object representing a category for personnel file entries. - **name** (string): The user-assigned name of the personnel file category. - **key** (string): The unique key of the personnel file category. - **creationDate** (string (date)): The creation date of the personnel file entry in YYYY-MM-DD format. - **documents** (array (string)) - **id** (string): The unique ID (an incrementing counter) of the personnel file entry. - **name** (string): The user-assigned name of the personnel file entry. - **notes** (string): A custom comment/note. Can include html tags. - **resubmissionDate** (string (date)): The future date for resubmission of the personnel file entry. Date in YYYY-MM-DD format. - **changeDate** (string (date)): Stores the date when the personnel file entry was most recently edited. Date in YYYY-MM-DD format. - **changedBy** (string): Records the firstname and lastname of the person who last edited a personnel file entry. - **createdBy** (object) - **externalIds** (array (ExternalId)): The ids of the person in external systems. Array items: - **externalSystem** (string): The external system this id belongs to. - **id** (string): The value of the id. - **firstName** (string): The given name of the person. - **lastName** (string): The surname of the person. - **personId** (string): The HR WORKS username of the person. - **personnelNumber** (string): The personnel number of the person. - **personIdentifierForKiosk** (string): The person identifier for kiosk of the person. - **datevPersonnelNumber** (string): The DATEV personnel number of the person. This attribute is only returned if the DATEV integration is active. - **uuid** (string): The unique identifier of the person in HR WORKS. This identifier does not change. - **isWageRelevant** (boolean): Specifies whether the personnel file is relevant to wages. #### default - Error payload. See #/responses for a list of general API errors. **ApiError** - **errorCode** (number): The HTTP error code, e.g. 403. - **type** (string): A string identifier for the error, e.g. InvalidCredentialsError - **errorMessage** (string): A text description of the error. Refer to this description in order to identify a solution for the problem. - **additionalErrors** (array (ApiError)): Sub-errors that might be attached to the main error object. Array items: ### Example Usage ```bash curl -X GET "https://api.hrworks.de/v2/persons/{personIdentifier}/personnel-file?personIdentifierType=value&category=string&hasDocuments=true&isWageRelevant=true&createdAfter=2023-01-01&createdBefore=2023-01-01" ``` ``` -------------------------------- ### GET /v2/working-times/projects Source: https://api.hrworks.de/v2/openapi.yaml Returns a list of time tracking projects in the specified date interval. ```markdown ### Parameters - **beginDate** (string (date), query, optional): The begin date of the interval to look for time tracking projects. Date in YYYY-MM-DD format. - **endDate** (string (date), query, optional): The end date of the interval to look for time tracking projects. Date in YYYY-MM-DD format. - **numbers** (array (string), query, optional): Set this parameter to only get the time tracking projects with the matching projectNumber. - **statusFilter** (array (TimeTrackingProjectStatus), query, optional): Set this parameter to only get time tracking projects with the given status. - **projectType** (TimeTrackingProjectType, query, optional): This parameter can be used to apply a filter to the result by specifying a certain project type. - **page** (number, query, optional): Set this parameter to access a specific page of results. If the parameter is not set, the first page of results is returned. The API returns paging information via the Link header. The page size for this API call is 50. - **projectIds** (array (string), query, optional): Set this parameter to recieve only the time tracking projects with the matching projectIds. - **projectManagerPersonnelNumber** (string, query, optional): Set this parameter to only receive the time tracking projects with the matching project manager for the personnelNumber. - **projectCustomerId** (string, query, optional): Set this parameter to only receive the time tracking projects with the matching project customer for the id ### Responses #### 200 - successful operation **GetTimeTrackingProjectsResponse** - **projects** (array (TimeTrackingProject)) Array items: - **id** (string): The id of the time tracking project. - **number** (number): The number of the project. - **name** (string): Answer the name of the time tracking project. - **beginDate** (string (date)): The begin date of the time tracking project in YYYY-MM-DD format. - **endDate** (string (date)): The end date of the time tracking project in YYYY-MM-DD format. - **description** (string): The description of the time tracking project. - **parentProject** (number): Answer the unique number of the parentProject. - **statusIdentifier** (string (active|completed|planned|blocked)) ("active"|"completed"|"planned"|"blocked") - **status** (string): Locale-specific string representation of the project status. - **hourlyBudget** (string): The hourly budget in total minutes. - **hasSubProjects** (boolean): Answer whether the time tracking project has any subProjects. - **projectManager** (object) - **externalIds** (array (ExternalId)): The ids of the person in external systems. Array items: - **externalSystem** (string): The external system this id belongs to. - **id** (string): The value of the id. - **firstName** (string): The given name of the person. - **lastName** (string): The surname of the person. - **personId** (string): The HR WORKS username of the person. - **personnelNumber** (string): The personnel number of the person. - **personIdentifierForKiosk** (string): The person identifier for kiosk of the person. - **datevPersonnelNumber** (string): The DATEV personnel number of the person. This attribute is only returned if the DATEV integration is active. - **uuid** (string): The unique identifier of the person in HR WORKS. This identifier does not change. - **customer** (object): Object representing a customer - **id** (string): The unique identifier of the customer. - **number** (string): The customer number. - **name** (string): Name of the customer. - **isActive** (boolean): Indicates whether the customer is currently in use. - **projectTeam** (object): Object representing the team of a time tracking project - **activePersons** (array (PersonBaseData)) Array items: - **inactivePersons** (array (PersonBaseData)) Array items: #### default - Error payload. See #/responses for a list of general API errors. **ApiError** - **errorCode** (number): The HTTP error code, e.g. 403. - **type** (string): A string identifier for the error, e.g. InvalidCredentialsError - **errorMessage** (string): A text description of the error. Refer to this description in order to identify a solution for the problem. - **additionalErrors** (array (ApiError)): Sub-errors that might be attached to the main error object. Array items: ### Example Usage ```bash curl -X GET "https://api.hrworks.de/v2/working-times/projects?beginDate=2023-01-01&endDate=2023-01-01&numbers=item1,item2&statusFilter=item1,item2&projectType=value&page=1&projectIds=item1,item2&projectManagerPersonnelNumber=string&projectCustomerId=string" ``` ``` -------------------------------- ### GET /v2/applicant-management/posts/{uuid} Source: https://api.hrworks.de/v2/openapi.yaml Returns the data of a single post with the given id. ```markdown ### Parameters - **uuid** (string, path, required): The uuid or id of the post in HR WORKS. The unique identifier cannot be changed. The passing of the id is deprecated. ### Responses #### 200 - successful operation **Post** - **displayName** (string): The name of the post, to be displayed in a job portal. - **name** (string): The name of the post. - **key** (string): The unique key of the post. - **uuid** (string): The unique identifier of the post. This identifier does not change. - **organizationUnitNumber** (string): The number of the organization unit, the post belongs to. - **organizationUnitUuid** (string): The unique identifier of the organization unit the post belongs to. - **contactInformation** (object) - **contactPerson** (object) - **externalIds** (array (ExternalId)): The ids of the person in external systems. Array items: - **externalSystem** (string): The external system this id belongs to. - **id** (string): The value of the id. - **firstName** (string): The given name of the person. - **lastName** (string): The surname of the person. - **personId** (string): The HR WORKS username of the person. - **personnelNumber** (string): The personnel number of the person. - **personIdentifierForKiosk** (string): The person identifier for kiosk of the person. - **datevPersonnelNumber** (string): The DATEV personnel number of the person. This attribute is only returned if the DATEV integration is active. - **uuid** (string): The unique identifier of the person in HR WORKS. This identifier does not change. - **phone** (string): The telephone number to contact. - **email** (string): The email address to contact. - **scopeOfActivities** (string): The translated scope of activities of the post. - **scopeOfActivitiesKey** (string (administration|analysisAndStatistics|consulting|customerService|engineeringAndTechnical|financeAccountingAndControlling|graphicDesignAndArchitecture|healthMedicalAndSocial|hr|itAndSoftwareDevelopment|legal|managementAndCorporateDevelopment|marketingAndAdvertising|notSpecified|otherDisciplines|prAndJournalism|processPlanningAndQa|productionAndManufacturing|productManagement|projectManagement|purchasingMaterialsManagementAndLogistics|salesAndCommerce|researchAndDevelopment)): The unique key of the scope of activities of the post. ("administration"|"analysisAndStatistics"|"consulting"|"customerService"|"engineeringAndTechnical"|"financeAccountingAndControlling"|"graphicDesignAndArchitecture"|"healthMedicalAndSocial"|"hr"|"itAndSoftwareDevelopment"|"legal"|"managementAndCorporateDevelopment"|"marketingAndAdvertising"|"notSpecified"|"otherDisciplines"|"prAndJournalism"|"processPlanningAndQa"|"productionAndManufacturing"|"productManagement"|"projectManagement"|"purchasingMaterialsManagementAndLogistics"|"salesAndCommerce"|"researchAndDevelopment") - **isActive** (boolean): Specifies if the post is set to active. - **postImageUrl** (string): The S3-URL of the cover image assigned to the post. - **postDescriptions** (object): Description texts of a post. Used in applicant management endpoints. - **introduction** (object) - **title** (string) - **description** (string) - **tasks** (object) - **profile** (object) - **offer** (object) - **summary** (object) - **postOffers** (array (PostOffer)) Array items: - **id** (string): The ID of the postOffer. - **postOfferNameSuffix** (string): The post offer name suffix to show after the display name of the post. - **permanentEstablishments** (array (PermanentEstablishment)) Array items: - **id** (string) - **name** (string) - **address** (object) - **additionalData** (string): Additional data attached to the address, e.g. c/o information. - **city** (string): The city/town associated with the address. - **country** (string): The locale-specific name of the address country, e.g. Germany. - **fax** (string): The fax number associated with the address. Only returned for addresses of permanent establishments. - **internationalCountryCode** (string): The address country code. Given as a 3-digit country code, e.g. DEU. - **phone** (string): The phone number associated with the address. - **state** (string): The ISO 3166-2 ID of the country member state, e.g. DE-BW. - **street** (string): The street associated with the address. - **streetNumber** (string): The street number. - **zipCode** (string): The postal code of the address. - **number** (string): The eight-digit identification number of the permanent establishment. - **placeOfWorkType** (string): The translated place of work type of the post offer, e.g. 'hybrid'. - **placeOfWorkTypeKey** (string (hybrid|onsite|remote)): The unique key of the place of work type of the post offer. ("hybrid"|"onsite"|"remote") - **employmentContract** (string): The translated employment contract type of the post offer. - **employmentContractKey** (string (notSpecified|apprenticeship|externalEmployee|internship|marginalEmployment|permanentEmployment|shortTermEmployment|studentJob)) ("notSpecified"|"apprenticeship"|"externalEmployee"|"internship"|"marginalEmployment"|"permanentEmployment"|"shortTermEmployment"|"studentJob") - **careerLevel** (string): The career level of the post offer, e.g. 'Professional'. - **careerLevelKey** (string (notSpecified|apprenticeOrWorkingStudent|executive|manager|professional|seniorExecutive|youngProfessional)) ("notSpecified"|"apprenticeOrWorkingStudent"|"executive"|"manager"|"professional"|"seniorExecutive"|"youngProfessional") - **description** (string): Description of the post offer. - **displayName** (string): The name of the post offer to display in job portals. - **jobPortal** (string): Given job portal of the post offer. - **priority** (number): The priority of the post offer. - **publicationDate** (string (date)): The date on which the post offer should be published. Date in YYYY-MM-DD format. - **validUntilDate** (string (date)): The date after which the post offer expires. Only present, if the visibility of the offer is set to a limited period of time. Date in YYYY-MM-DD format. - **workingTimeModel** (string): The translated name of the working time model of the post offer. - **workingTimeModelKey** (string (notSpecified|fullTime|fullTimeOrPartTime|partTime)) ("notSpecified"|"fullTime"|"fullTimeOrPartTime"|"partTime") - **isActive** (boolean): Specifies if the post offer is set to active. - **howDidYouHearAboutUsOptions** (object) - **en** (array (string)): All possible english options that describe how the applicant became aware of the post/company. - **de** (array (string)): All possible german options that describe how the applicant became aware of the post/company. #### default - Error payload. See #/responses for a list of general API errors. **ApiError** - **errorCode** (number): The HTTP error code, e.g. 403. - **type** (string): A string identifier for the error, e.g. InvalidCredentialsError - **errorMessage** (string): A text description of the error. Refer to this description in order to identify a solution for the problem. - **additionalErrors** (array (ApiError)): Sub-errors that might be attached to the main error object. Array items: ### Example Usage ```bash curl -X GET "https://api.hrworks.de/v2/applicant-management/posts/{uuid}" ``` ``` -------------------------------- ### GET /v2/working-times/projects/customers/{customerNumber} Source: https://api.hrworks.de/v2/openapi.yaml Returns a time tracking project customer by the customer number. ```markdown ### Parameters - **customerNumber** (string, path, required): The customer number of the project customer. ### Responses #### 200 - successful operation **TimeTrackingProjectCustomer** - **id** (string): The unique identifier of the customer. - **number** (string): The customer number. - **name** (string): Name of the customer. - **isActive** (boolean): Indicates whether the customer is currently in use. - **activeProjectCount** (number): The number of active projects of the customer. - **totalProjectCount** (number): The number of projects of the customer. #### default - Error payload. See #/responses for a list of general API errors. **ApiError** - **errorCode** (number): The HTTP error code, e.g. 403. - **type** (string): A string identifier for the error, e.g. InvalidCredentialsError - **errorMessage** (string): A text description of the error. Refer to this description in order to identify a solution for the problem. - **additionalErrors** (array (ApiError)): Sub-errors that might be attached to the main error object. Array items: ### Example Usage ```bash curl -X GET "https://api.hrworks.de/v2/working-times/projects/customers/{customerNumber}" ``` ``` -------------------------------- ### POST /v2/persons/onboarding/{id}/files Source: https://api.hrworks.de/v2/openapi.yaml Create a new file for an onboarding document in HR WORKS by sending the binary data in body or an URL to download the file from. ```markdown ### Parameters - **content-type** (string, header, required): The Mime-type of the file. - **fileName** (string, query, required): The name of the file to display in HR WORKS. - **id** (string, path, required): The id of the onboarding document that the uploaded file belongs to. - **url** (string, query, optional): The url of the document (required if the file is not sent via the request body). ### Request Body **Content-Type:** application/octet-stream **Content-Type:** application/json - **webhook** (object) - **url** (string): The URL of the webhook. - **headers** (unknown) ### Responses #### 200 - Success response. The jobId returned with this call can be used to query the persons/onboarding/jobs endpoint for the result of the write operation. **JobIdObject** - **jobId** (string): A GUID referencing the write request. Can be used for calls to the respective /jobs endpoint. #### default - Error payload. See #/responses for a list of general API errors. **ApiError** - **errorCode** (number): The HTTP error code, e.g. 403. - **type** (string): A string identifier for the error, e.g. InvalidCredentialsError - **errorMessage** (string): A text description of the error. Refer to this description in order to identify a solution for the problem. - **additionalErrors** (array (ApiError)): Sub-errors that might be attached to the main error object. Array items: ### Example Usage ```bash curl -X POST "https://api.hrworks.de/v2/persons/onboarding/{id}/files?fileName=string&url=string" \ -H "Content-Type: application/json" \ -d '"string"' ``` ```