Organization | Employees
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
Filter by one or multiple specific locations
Filter the employees by one or multiple usernames
Filter the employees created after the specified date.
Parameters according to which an employee can be sorted.
Order in which the result of a list request is sorted.
Specifies the index of the first item to return
0Specifies the maximum number of items to return (min: 1; max: 1000)
100OK: Returns a list of employees.
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
Employee number in the company. Usually created by the HR system/process.
42The employee onboarding date.
2024-04-01The employee offboarding date.
2024-11-30The contact mail address.
j.doe@foo.incPattern: ^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$The first/given name of the employee.
JohnThe last/family name of the employee.
DoeThe identifier of the location where the employee works.
1Free text notes.
Will take a sabbatical in July.The phone number of the employees business mobile phone.
+49 555 4523The phone number of the employees workplace.
+49 555 6273The job position or job title of the employee
Account ManagerStatus of an employee
The identifier of an employee who is the supervisor for this employee.
1The username to log in to the app. The value has to be an e-mail address.
j.doe@foo.incPattern: ^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$The cost center of the employee.
4645-2343Controls whether the employee can access the self-service portal.
Created: The created employee.
Employee number in the company. Usually created by the HR system/process.
42The job position or job title of the employee
Account ManagerThe private email address.
p.bell@abc.comThe phone number of the employees workplace.
+49 555 6273The phone number of the employees business mobile phone.
+49 555 4523Free text notes.
Will take a sabbatical in July.The date and time the data record was created.
The employee onboarding date.
The employee offboarding date.
Status of an employee
The identifier of the employee.
1The first/given name of the employee.
PierceThe last/family name of the employee.
BellCombination of last and firstname
The contact and login mail address.
p.bell@foo.ioThe username to log in to the app. The value has to be an e-mail address.
j.doe@foo.incPattern: ^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$The cost center of the employee.
4645-2343The identifier of the cost center.
1Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the employee.
OK: The requested employee.
Employee number in the company. Usually created by the HR system/process.
42The job position or job title of the employee
Account ManagerThe private email address.
p.bell@abc.comThe phone number of the employees workplace.
+49 555 6273The phone number of the employees business mobile phone.
+49 555 4523Free text notes.
Will take a sabbatical in July.The date and time the data record was created.
The employee onboarding date.
The employee offboarding date.
Status of an employee
The identifier of the employee.
1The first/given name of the employee.
PierceThe last/family name of the employee.
BellCombination of last and firstname
The contact and login mail address.
p.bell@foo.ioThe username to log in to the app. The value has to be an e-mail address.
j.doe@foo.incPattern: ^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$The cost center of the employee.
4645-2343The identifier of the cost center.
1Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the employee to be updated.
If true, the cost center of all instances will be update in case the cost center from employee has changed
trueThe contact mail address.
j.doe@foo.incPattern: ^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$The first/given name of the employee.
JohnThe last/family name of the employee.
DoeThe identifier of the location where the employee works.
1Free text notes.
Will take a sabbatical in July.The phone number of the employees business mobile phone.
+49 555 4523The phone number of the employees workplace.
+49 555 6273The job position or job title of the employee
Account ManagerStatus of an employee
The identifier of an employee who is the supervisor for this employee.
1The username to log in to the app. The value has to be an e-mail address.
j.doe@foo.incPattern: ^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$The cost center of the employee.
4645-2343Controls whether the employee can access the self-service portal.
NoContent: Request has succeeded.
No content
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
No content
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the employee to be invited.
Configures the invitation to be sent to the employee.
Additional message which will displayed in the invitation mail below the regular information. Can be used to give the employee further information.
Welcome to our DaaS portal!\nEnjoy browsing our service marketplace.NoContent: Request has succeeded.
No content
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
No content
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
Ok
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The unique employee identifier
DTO for creating a new metadata entry for a given resource which implements the logic
Key for the new metadata entry
Metadata value
Created: The created metadata entry.
Metadata value
EQ1337555Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.
SupplierMetadata key used as a unique identifier for the metadata item.
ExternalSystemIdBad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
Employee unique id
metadata key
Ok
Metadata value
EQ1337555Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.
SupplierMetadata key used as a unique identifier for the metadata item.
ExternalSystemIdBad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The unique employee id
The metadata key
NoContent
No content
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
No content
Last updated
Was this helpful?