{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/business:personio-data/employees-get-list":{"get":{"operationId":"business_personio_data_employees_get_list","summary":"List Company Employees","description":"GET /company/employees","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}},{"name":"limit","in":"query","required":false,"description":"Pagination attribute to limit the number of employees returned per page.","schema":{"type":"integer","default":10,"description":"Pagination attribute to limit the number of employees returned per page."}},{"name":"offset","in":"query","required":false,"description":"Pagination attribute to identify the first item in the collection to return.","schema":{"type":"integer","default":0,"description":"Pagination attribute to identify the first item in the collection to return."}},{"name":"email","in":"query","required":false,"description":"Find an employee with the given email address. The response is still a list, containing only the filtered employee. NOTE: when using the…","schema":{"type":"string","description":"Find an employee with the given email address. The response is still a list, containing only the filtered employee. NOTE: when using the…"}},{"name":"attributes[]","in":"query","required":false,"description":"A list of attributes that will be returned for the employees, ie. a projection of the employee fields and relationships. In case…","schema":{"type":"array","description":"A list of attributes that will be returned for the employees, ie. a projection of the employee fields and relationships. In case…"},"example":"?attributes[]=first_name&attributes[]=last_name"},{"name":"updated_since","in":"query","required":false,"description":"Filter to select and return only the employees that have been updated after `updated_since`. When it is used together with the…","schema":{"type":"string","description":"Filter to select and return only the employees that have been updated after `updated_since`. When it is used together with the…"},"example":"2022-12-24T08:15:30"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/employees-create-employee":{"post":{"operationId":"business_personio_data_employees_create_employee","summary":"Create an employee","description":"POST /company/employees","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-Personio-Partner-ID":{"type":"string","description":"The partner identifier"},"X-Personio-App-ID":{"type":"string","description":"The application identifier"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:personio-data/employees-show-by-id":{"get":{"operationId":"business_personio_data_employees_show_by_id","summary":"Show employee by ID","description":"GET /company/employees/{employee_id}","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}},{"name":"employee_id","in":"query","required":true,"description":"Numeric `id` of the employee","schema":{"type":"integer","description":"Numeric `id` of the employee"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/employees-update-employee-fields":{"post":{"operationId":"business_personio_data_employees_update_employee_fields","summary":"Update an employee","description":"PATCH /company/employees/{employee_id}","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["employee_id"],"properties":{"X-Personio-Partner-ID":{"type":"string","description":"The partner identifier"},"X-Personio-App-ID":{"type":"string","description":"The application identifier"},"employee_id":{"type":"integer","description":"Numeric `id` of the employee"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:personio-data/employees-get-absence-balance":{"get":{"operationId":"business_personio_data_employees_get_absence_balance","summary":"Retrieve the absence balance for a specific employee","description":"GET /company/employees/{employee_id}/absences/balance","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}},{"name":"employee_id","in":"query","required":true,"description":"Numeric `id` of the employee","schema":{"type":"integer","description":"Numeric `id` of the employee"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/employees-get-custom-attributes":{"get":{"operationId":"business_personio_data_employees_get_custom_attributes","summary":"This endpoint is an alias for `/company/employees/attributes`.","description":"GET /company/employees/custom-attributes","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/employees-list-attributes":{"get":{"operationId":"business_personio_data_employees_list_attributes","summary":"Lists all the allowed atrributes per API credentials including custom (dynamic) attributes.","description":"GET /company/employees/attributes","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/employees-show-profile-picture":{"get":{"operationId":"business_personio_data_employees_show_profile_picture","summary":"Show employee's profile picture. If profile picture is missing, the 404 error will be thrown. The `Profile…","description":"GET /company/employees/{employee_id}/profile-picture/{width}","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}},{"name":"employee_id","in":"query","required":true,"description":"Numeric `id` of the employee","schema":{"type":"integer","description":"Numeric `id` of the employee"}},{"name":"width","in":"query","required":true,"description":"Width of the image. Default is original size","schema":{"type":"integer","description":"Width of the image. Default is original size"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/attendances-get-list":{"get":{"operationId":"business_personio_data_attendances_get_list","summary":"Fetch attendance data for the company employees. The result can be `paginated` and `filtered` by period, the…","description":"GET /company/attendances","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}},{"name":"start_date","in":"query","required":true,"description":"First day of the period to be queried. It is inclusive, so the day specified as start_date will also be considered on the results","schema":{"type":"string","description":"First day of the period to be queried. It is inclusive, so the day specified as start_date will also be considered on the results"}},{"name":"end_date","in":"query","required":true,"description":"Last day of the period to be queried. It is inclusive, so the day specified as end_date will also be considered on the results.","schema":{"type":"string","description":"Last day of the period to be queried. It is inclusive, so the day specified as end_date will also be considered on the results."}},{"name":"updated_from","in":"query","required":false,"description":"Datetime from when the queried periods have been updated. Same format as updated_at. It is inclusive, so the day specified as updated_from…","schema":{"type":"string","description":"Datetime from when the queried periods have been updated. Same format as updated_at. It is inclusive, so the day specified as updated_from…"}},{"name":"updated_to","in":"query","required":false,"description":"Datetime until when the queried periods have been updated. Same format as updated_at. It is inclusive, so the day specified as updated_to…","schema":{"type":"string","description":"Datetime until when the queried periods have been updated. Same format as updated_at. It is inclusive, so the day specified as updated_to…"}},{"name":"includePending","in":"query","required":false,"description":"Returns AttendancePeriods with a status of pending, rejected and confirmed. For pending periods, the end_date attribute is nullable. The…","schema":{"type":"boolean","description":"Returns AttendancePeriods with a status of pending, rejected and confirmed. For pending periods, the end_date attribute is nullable. The…"}},{"name":"employees[]","in":"query","required":false,"description":"A list of Personio employee ID's to filter the results. The result filters including only attendances of provided employees.","schema":{"type":"array","description":"A list of Personio employee ID's to filter the results. The result filters including only attendances of provided employees."}},{"name":"limit","in":"query","required":false,"description":"Pagination attribute to limit how many attendances are per page","schema":{"type":"integer","default":200,"description":"Pagination attribute to limit how many attendances are per page"}},{"name":"offset","in":"query","required":false,"description":"The offset from the first record that would be returned. With 3 results [A, B, C] and an offset of 1, the following two results will be…","schema":{"type":"integer","default":0,"description":"The offset from the first record that would be returned. With 3 results [A, B, C] and an offset of 1, the following two results will be…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/attendances-create-multiple-attendances":{"post":{"operationId":"business_personio_data_attendances_create_multiple_attendances","summary":"This endpoint is responsible for adding attendance data for the company employees. It is possible to add…","description":"POST /company/attendances","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"X-Personio-Partner-ID":{"type":"string","description":"The partner identifier"},"X-Personio-App-ID":{"type":"string","description":"The application identifier"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:personio-data/attendances-update-attendance-data":{"post":{"operationId":"business_personio_data_attendances_update_attendance_data","summary":"This endpoint is responsible for updating attendance data for the company employees. Attributes are not…","description":"PATCH /company/attendances/{id}","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"X-Personio-Partner-ID":{"type":"string","description":"The partner identifier"},"X-Personio-App-ID":{"type":"string","description":"The application identifier"},"id":{"type":"integer","description":"ID of the attendance period to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:personio-data/attendances-delete-data":{"post":{"operationId":"business_personio_data_attendances_delete_data","summary":"This endpoint is responsible for deleting attendance data for the company employees.","description":"DELETE /company/attendances/{id}","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"X-Personio-Partner-ID":{"type":"string","description":"The partner identifier"},"X-Personio-App-ID":{"type":"string","description":"The application identifier"},"id":{"type":"integer","description":"ID of the attendance period to delete"},"skip_approval":{"type":"boolean","default":true,"description":"Optional, default value is true. If set to false, the approval status of the attendance period will be \"pending\" if an approval rule is…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:personio-data/projects-get-all":{"get":{"operationId":"business_personio_data_projects_get_all","summary":"Provides a list of all company projects.","description":"GET /company/attendances/projects","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/projects-create-project":{"post":{"operationId":"business_personio_data_projects_create_project","summary":"Creates a project into the company account","description":"POST /company/attendances/projects","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-Personio-Partner-ID":{"type":"string","description":"The partner identifier"},"X-Personio-App-ID":{"type":"string","description":"The application identifier"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:personio-data/projects-update-data":{"post":{"operationId":"business_personio_data_projects_update_data","summary":"Updates a project with the given data","description":"PATCH /company/attendances/projects/{id}","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"Numeric `id` of the project"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:personio-data/projects-delete-project":{"post":{"operationId":"business_personio_data_projects_delete_project","summary":"Deletes a project from the company account","description":"DELETE /company/attendances/projects/{id}","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"Numeric `id` of the project"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:personio-data/absences-list-time-off-types":{"get":{"operationId":"business_personio_data_absences_list_time_off_types","summary":"Provides a list of absence types for absences **time unit** set to either **days** or **hours**. For example…","description":"GET /company/time-off-types","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}},{"name":"limit","in":"query","required":false,"description":"Pagination attribute to limit how many records will be returned per page","schema":{"type":"integer","default":200,"description":"Pagination attribute to limit how many records will be returned per page"}},{"name":"offset","in":"query","required":false,"description":"Pagination attribute to identify which page you are requesting, by the form of telling an offset from the first record that would be…","schema":{"type":"integer","default":0,"description":"Pagination attribute to identify which page you are requesting, by the form of telling an offset from the first record that would be…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/absences-get-absence-periods":{"get":{"operationId":"business_personio_data_absences_get_absence_periods","summary":"Fetches absence periods for absences with **time unit** set to **days**. The result can be `paginated` and…","description":"GET /company/time-offs","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}},{"name":"start_date","in":"query","required":false,"description":"First day of the period to be queried. It is inclusive, so the result starts from and including the provided `start_date`","schema":{"type":"string","description":"First day of the period to be queried. It is inclusive, so the result starts from and including the provided `start_date`"}},{"name":"end_date","in":"query","required":false,"description":"Last day of the period to be queried. It is inclusive, so the result ends on `end_date` including absences from the `end_date`","schema":{"type":"string","description":"Last day of the period to be queried. It is inclusive, so the result ends on `end_date` including absences from the `end_date`"}},{"name":"updated_from","in":"query","required":false,"description":"Query the periods that created or modified from the date `updated_from`. It is inclusive, so all the periods created or modified from the…","schema":{"type":"string","description":"Query the periods that created or modified from the date `updated_from`. It is inclusive, so all the periods created or modified from the…"}},{"name":"updated_to","in":"query","required":false,"description":"Query the periods that created or modified until the date `updated_to`. It is inclusive, so all the periods created or modified until the…","schema":{"type":"string","description":"Query the periods that created or modified until the date `updated_to`. It is inclusive, so all the periods created or modified until the…"}},{"name":"employees[]","in":"query","required":false,"description":"A list of Personio employee ID's to filter the results. The result filters including only absences of provided employees","schema":{"type":"array","description":"A list of Personio employee ID's to filter the results. The result filters including only absences of provided employees"}},{"name":"limit","in":"query","required":false,"description":"Pagination attribute to limit the number of absence periods per page","schema":{"type":"integer","default":200,"description":"Pagination attribute to limit the number of absence periods per page"}},{"name":"offset","in":"query","required":false,"description":"Pagination attribute to identify which page number you are requesting","schema":{"type":"integer","default":0,"description":"Pagination attribute to identify which page number you are requesting"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/absences-add-absence-data":{"post":{"operationId":"business_personio_data_absences_add_absence_data","summary":"Adds absence data for absence types with **time unit** set to **days**.","description":"POST /company/time-offs","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"X-Personio-Partner-ID":{"type":"string","description":"The partner identifier"},"X-Personio-App-ID":{"type":"string","description":"The application identifier"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:personio-data/absences-get-absence-period":{"get":{"operationId":"business_personio_data_absences_get_absence_period","summary":"Gets an absence period for absences with **time unit** set to **days**.","description":"GET /company/time-offs/{id}","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}},{"name":"id","in":"query","required":true,"description":"Numeric `id` of the absence period","schema":{"type":"integer","description":"Numeric `id` of the absence period"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/absences-delete-absence-data":{"post":{"operationId":"business_personio_data_absences_delete_absence_data","summary":"Deletes absence period data for absence types with **time unit** set to **days**.","description":"DELETE /company/time-offs/{id}","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"X-Personio-Partner-ID":{"type":"string","description":"The partner identifier"},"X-Personio-App-ID":{"type":"string","description":"The application identifier"},"id":{"type":"integer","description":"ID of the absence period to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:personio-data/absences-get-hourly-periods":{"get":{"operationId":"business_personio_data_absences_get_hourly_periods","summary":"Fetches absence periods for absences with **time unit** set to **hours**. The result can be `paginated` and…","description":"GET /company/absence-periods","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}},{"name":"start_date","in":"query","required":false,"description":"Filter by absence periods that start at or before given date.","schema":{"type":"string","description":"Filter by absence periods that start at or before given date."}},{"name":"end_date","in":"query","required":false,"description":"Filter by absence periods that start at or before given date.","schema":{"type":"string","description":"Filter by absence periods that start at or before given date."}},{"name":"updated_from","in":"query","required":false,"description":"Filter by periods that were created or modified from the date updated_from. It is inclusive, so all the periods created or modified from…","schema":{"type":"string","description":"Filter by periods that were created or modified from the date updated_from. It is inclusive, so all the periods created or modified from…"}},{"name":"updated_to","in":"query","required":false,"description":"Filter by periods that were created or modified until the date updated_to. It is inclusive, so all the periods created or modified until…","schema":{"type":"string","description":"Filter by periods that were created or modified until the date updated_to. It is inclusive, so all the periods created or modified until…"}},{"name":"employees[]","in":"query","required":false,"description":"A list of Personio employee ID's to filter the results. The result filters including only absences of provided employees","schema":{"type":"array","description":"A list of Personio employee ID's to filter the results. The result filters including only absences of provided employees"}},{"name":"absence_types[]","in":"query","required":false,"description":"A list of Personio absence type IDs to filter the results. The result filters including only absences of provided absence types.","schema":{"type":"array","description":"A list of Personio absence type IDs to filter the results. The result filters including only absences of provided absence types."}},{"name":"absence_periods[]","in":"query","required":false,"description":"A list of Personio absence period IDs to filter the results. The result filters including only absences containing the provided ids.","schema":{"type":"array","description":"A list of Personio absence period IDs to filter the results. The result filters including only absences containing the provided ids."}},{"name":"limit","in":"query","required":false,"description":"Pagination attribute to limit how many absence periods are returned per page.","schema":{"type":"integer","default":200,"description":"Pagination attribute to limit how many absence periods are returned per page."}},{"name":"offset","in":"query","required":false,"description":"Pagination attribute to identify which page you are requesting, by the form of telling an offset from the first record that would be…","schema":{"type":"integer","default":0,"description":"Pagination attribute to identify which page you are requesting, by the form of telling an offset from the first record that would be…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/absences-add-absence-periods-data":{"post":{"operationId":"business_personio_data_absences_add_absence_periods_data","summary":"Adds absence data for absence types with **time unit** set to **hours**. Note that creating periods for…","description":"POST /company/absence-periods","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"X-Personio-Partner-ID":{"type":"string","description":"The partner identifier"},"X-Personio-App-ID":{"type":"string","description":"The application identifier"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:personio-data/absences-delete-period-data":{"post":{"operationId":"business_personio_data_absences_delete_period_data","summary":"Deletes absence period data for absence types with **time unit** set to **hours**.","description":"DELETE /company/absence-periods/{id}","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"X-Personio-Partner-ID":{"type":"string","description":"The partner identifier"},"X-Personio-App-ID":{"type":"string","description":"The application identifier"},"id":{"type":"string","description":"ID of the absence period to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:personio-data/documents-get-categories":{"get":{"operationId":"business_personio_data_documents_get_categories","summary":"This endpoint is responsible for fetching all document categories of the company. The result contains a list…","description":"GET /company/document-categories","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/documents-upload-for-employees":{"post":{"operationId":"business_personio_data_documents_upload_for_employees","summary":"This endpoint is responsible for uploading documents for the company employees.","description":"POST /company/documents","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-Personio-Partner-ID":{"type":"string","description":"The partner identifier"},"X-Personio-App-ID":{"type":"string","description":"The application identifier"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:personio-data/custom-reports-get-metadata":{"get":{"operationId":"business_personio_data_custom_reports_get_metadata","summary":"This endpoint provides you with metadata about existing custom reports in your Personio account, such as…","description":"GET /company/custom-reports/reports","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}},{"name":"report_ids","in":"query","required":false,"description":"A list of report ID's to filter the results.","schema":{"type":"array","description":"A list of report ID's to filter the results."},"example":"eea50309-d1b1-47d6-bc7e-27de7a3ab491, baa50309-d1b1-47d6-bc76-27de7a3ab491"},{"name":"status","in":"query","required":false,"description":"The status of the report to filter the results.","schema":{"type":"string","description":"The status of the report to filter the results."},"example":"up_to_date"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/custom-reports-get-data":{"get":{"operationId":"business_personio_data_custom_reports_get_data","summary":"This endpoint provides you with the data of an existing Custom Report.","description":"GET /company/custom-reports/reports/{report_id}","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}},{"name":"report_id","in":"query","required":true,"description":"The ID of the report to filter the result.","schema":{"type":"string","description":"The ID of the report to filter the result."},"example":"eea50309-d1b1-47d6-bc7e-27de7a3ab491"},{"name":"locale","in":"query","required":false,"description":"locale used to translate localized fields.","schema":{"type":"string","description":"locale used to translate localized fields."},"example":"de"},{"name":"page","in":"query","required":false,"description":"Pagination parameter to identify the page to return.","schema":{"type":"integer","description":"Pagination parameter to identify the page to return."},"example":1},{"name":"limit","in":"query","required":false,"description":"Pagination parameter to limit the number of employees returned per page.","schema":{"type":"integer","description":"Pagination parameter to limit the number of employees returned per page."},"example":10}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/business:personio-data/custom-reports-get-column-labels":{"get":{"operationId":"business_personio_data_custom_reports_get_column_labels","summary":"This endpoint provides human-readable labels for report table columns. It is particularly important if you…","description":"GET /company/custom-reports/columns","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"X-Personio-Partner-ID","in":"query","required":false,"description":"The partner identifier","schema":{"type":"string","description":"The partner identifier"}},{"name":"X-Personio-App-ID","in":"query","required":false,"description":"The application identifier","schema":{"type":"string","description":"The application identifier"}},{"name":"columns","in":"query","required":false,"description":"The columns to filter the results.","schema":{"type":"array","description":"The columns to filter the results."},"example":"first_name,last_name"},{"name":"locale","in":"query","required":false,"description":"locale used to translate localized fields.","schema":{"type":"string","description":"locale used to translate localized fields."},"example":"en"},{"name":"report_id","in":"query","required":false,"description":"The ID of the report to filter the result of the columns. If no ID is passed, all columns for the company are returned.","schema":{"type":"string","description":"The ID of the report to filter the result of the columns. If no ID is passed, all columns for the company are returned."},"example":"eea50309-d1b1-47d6-bc7e-27de7a3ab491"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}