{"openapi":"3.1.0","info":{"title":"Bindbee APIs","version":"0.1.0"},"paths":{"/api/hris/v1/bank-info":{"get":{"tags":["Bank Info"],"summary":"Get Bank Info List","description":"Returns a list of BankInfo objects.","operationId":"get_bank_info_list_api_hris_v1_bank_info_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of bank info records to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of bank info records to fetch"},{"name":"employee_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the employees for the bank info records to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Employee Id"},"description":"The ID of the employees for the bank info records to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"account_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The type of the bank account to fetch","examples":["SAVINGS","CHECKING"],"title":"Account Type"},"description":"The type of the bank account to fetch"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisBankInfo_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/bank-info/{id}":{"get":{"tags":["Bank Info"],"summary":"Get Bank Info By Id","description":"Returns a BankInfo object with the given id.","operationId":"get_bank_info_by_id_api_hris_v1_bank_info__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisBankInfo"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/benefits":{"get":{"tags":["Benefits"],"summary":"Get Benefits","description":"Returns a list of Benefit objects.","operationId":"get_benefits_api_hris_v1_benefits_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the benefits to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the benefits to fetch"},{"name":"employee_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the employees for the benefits to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Employee Id"},"description":"The ID of the employees for the benefits to fetch"},{"name":"employer_benefit_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the employer benefits for the benefits to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Employer Benefit Id"},"description":"The ID of the employer benefits for the benefits to fetch"},{"name":"benefit_plan_category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The category of the benefit plan to filter by (e.g., MEDICAL, VISION, DENTAL, RETIREMENT, etc.)","examples":["MEDICAL"],"title":"Benefit Plan Category"},"description":"The category of the benefit plan to filter by (e.g., MEDICAL, VISION, DENTAL, RETIREMENT, etc.)"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"coverage_tier","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The coverage tier of the benefit to filter by","examples":["WAIVED","EMPLOYEE_ONLY","EMPLOYEE_SPOUSE","EMPLOYEE_CHILD","EMPLOYEE_CHILDREN","EMPLOYEE_FAMILY","EMPLOYEE_DOMESTIC_PARTNER","HSA_FAMILY","SPOUSE","EMPLOYEE_1_DEPENDENT","EMPLOYEE_1_HOUSEHOLD_MEMBER"],"title":"Coverage Tier"},"description":"The coverage tier of the benefit to filter by"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"start_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Start Date From"},"description":"If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"start_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Start Date To"},"description":"If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"end_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"End Date From"},"description":"If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"end_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"End Date To"},"description":"If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"effective_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with effective_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Effective Date From"},"description":"If provided, only objects with effective_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"effective_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with effective_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Effective Date To"},"description":"If provided, only objects with effective_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisBenefit_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/benefits/{id}":{"get":{"tags":["Benefits"],"summary":"Get Benefit By Id","description":"Returns a Benefit object with the given id.","operationId":"get_benefit_by_id_api_hris_v1_benefits__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisBenefit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/benefit-coverages":{"get":{"tags":["Benefit Coverages"],"summary":"Get Benefit Coverages","description":"Returns a list of Benefit Coverage objects.","operationId":"get_benefit_coverages_api_hris_v1_benefit_coverages_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the benefit coverages to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the benefit coverages to fetch"},{"name":"benefit_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the benefits to fetch benefit coverages for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Benefit Id"},"description":"The ID of the benefits to fetch benefit coverages for"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisBenefitCoverage_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/benefit-coverages/{id}":{"get":{"tags":["Benefit Coverages"],"summary":"Get Benefit Coverage By Id","description":"Returns a Benefit Coverage object with the given id.","operationId":"get_benefit_coverage_by_id_api_hris_v1_benefit_coverages__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisBenefitCoverage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/companies":{"get":{"tags":["Company"],"summary":"Get Companies","description":"Returns a list of Companies objects.","operationId":"get_companies_api_hris_v1_companies_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of companies to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of companies to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisCompany_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/companies/{id}":{"get":{"tags":["Company"],"summary":"Get Company By Id","description":"Returns a Company object with the given id.","operationId":"get_company_by_id_api_hris_v1_companies__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisCompany"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/dependents":{"get":{"tags":["Dependents"],"summary":"Get Dependents","description":"Returns a list of Dependent objects.","operationId":"get_dependents_api_hris_v1_dependents_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the dependents to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the dependents to fetch"},{"name":"employee_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the employees to fetch dependents for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Employee Id"},"description":"The ID of the employees to fetch dependents for"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisDependent_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/dependents/{id}":{"get":{"tags":["Dependents"],"summary":"Get Dependent By Id","description":"Returns a Dependent object with the given id.","operationId":"get_dependent_by_id_api_hris_v1_dependents__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisDependent"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/dependent-benefits":{"get":{"tags":["Dependent Benefits"],"summary":"Get Dependent Benefits","description":"Returns a list of Dependent Benefit objects.","operationId":"get_dependent_benefits_api_hris_v1_dependent_benefits_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the dependent benefits to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the dependent benefits to fetch"},{"name":"employer_benefit_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the employer benefits to fetch dependent benefits for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Employer Benefit Id"},"description":"The ID of the employer benefits to fetch dependent benefits for"},{"name":"dependent_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the dependents to fetch dependent benefits for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Dependent Id"},"description":"The ID of the dependents to fetch dependent benefits for"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"start_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Start Date From"},"description":"If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"start_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Start Date To"},"description":"If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"end_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"End Date From"},"description":"If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"end_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"End Date To"},"description":"If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"effective_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with effective_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Effective Date From"},"description":"If provided, only objects with effective_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"effective_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with effective_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Effective Date To"},"description":"If provided, only objects with effective_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisDependentBenefit_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/dependent-benefits/{id}":{"get":{"tags":["Dependent Benefits"],"summary":"Get Dependent Benefit By Id","description":"Returns a Dependent Benefit object with the given id.","operationId":"get_dependent_benefit_by_id_api_hris_v1_dependent_benefits__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisDependentBenefit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/employer-benefits":{"get":{"tags":["Employer Benefits"],"summary":"Get Employer Benefits","description":"Returns a list of Employer Benefit objects.","operationId":"get_employer_benefits_api_hris_v1_employer_benefits_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the employer benefits to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the employer benefits to fetch"},{"name":"benefit_plan_category","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The category of the benefit plan to filter by (e.g., MEDICAL, VISION, DENTAL, RETIREMENT, etc.)","examples":["MEDICAL"],"title":"Benefit Plan Category"},"description":"The category of the benefit plan to filter by (e.g., MEDICAL, VISION, DENTAL, RETIREMENT, etc.)"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisEmployerBenefit_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/employer-benefits/{id}":{"get":{"tags":["Employer Benefits"],"summary":"Get Employer Benefit By Id","description":"Returns a Employer Benefit object with the given id.","operationId":"get_employer_benefit_by_id_api_hris_v1_employer_benefits__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisEmployerBenefit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/employees":{"get":{"tags":["Employee"],"summary":"Get Employees","description":"Returns a list of Employee objects.","operationId":"get_employees_api_hris_v1_employees_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of employees to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of employees to fetch"},{"name":"manager_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of managers to fetch employees for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Manager Id"},"description":"The ID of managers to fetch employees for"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"company_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of companies to fetch employees for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Company Id"},"description":"The ID of companies to fetch employees for"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"employment_status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return employees with this employment status. Along with the standard values, any connector specific value returned in the response can be passed as well.","examples":["ACTIVE","PENDING","INACTIVE","ACTIVE_EXTERNAL","INACTIVE_EXTERNAL","-","LEAVE","DECEASED","RETIRED"],"title":"Employment Status"},"description":"If provided, will only return employees with this employment status. Along with the standard values, any connector specific value returned in the response can be passed as well."},{"name":"employee_number","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return employees for this employee number","examples":["000000168"],"title":"Employee Number"},"description":"If provided, will only return employees for this employee number"},{"name":"first_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return employees with this first name (case-insensitive)","examples":["Jane"],"title":"First Name"},"description":"If provided, will only return employees with this first name (case-insensitive)"},{"name":"last_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return employees with this last name (case-insensitive)","examples":["Doe"],"title":"Last Name"},"description":"If provided, will only return employees with this last name (case-insensitive)"},{"name":"work_email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return employees with this work email (case-insensitive)","examples":["jane.doe@acme.com"],"title":"Work Email"},"description":"If provided, will only return employees with this work email (case-insensitive)"},{"name":"groups","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of groups to fetch employees for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Groups"},"description":"The ID of groups to fetch employees for"},{"name":"work_locations","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of locations to fetch employees for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Work Locations"},"description":"The ID of locations to fetch employees for"},{"name":"pay_group_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of pay groups to fetch employees for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Pay Group Id"},"description":"The ID of pay groups to fetch employees for"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisEmployeeResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Employee"],"summary":"Create Employee","description":"Creates an Employee object with the given values.","operationId":"create_employee_api_hris_v1_employees_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-idempotency-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Key to guarantee idempotent write execution.","title":"X-Idempotency-Key"},"description":"Key to guarantee idempotent write execution."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/employees/create/meta":{"get":{"tags":["Employee"],"summary":"Get Create Employee Request Body","description":"Returns the data points required to add new employee in HRIS","operationId":"get_create_employee_request_body_api_hris_v1_employees_create_meta_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaApiResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/employees/meta/post":{"get":{"tags":["Employee"],"summary":"Get Create Employee Meta","description":"Returns request schema for POST Employee request.","operationId":"get_create_employee_meta_api_hris_v1_employees_meta_post_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","additionalProperties":true},{"$ref":"#/components/schemas/MetaApiResponseModel"}],"title":"Response Get Create Employee Meta Api Hris V1 Employees Meta Post Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/employees/{id}":{"get":{"tags":["Employee"],"summary":"Get Employee By Id","description":"Returns an Employee object with the given id.","operationId":"get_employee_by_id_api_hris_v1_employees__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisEmployeeResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/employments":{"get":{"tags":["Employments"],"summary":"Get Employments","description":"Returns a list of Employment objects.","operationId":"get_employments_api_hris_v1_employments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the employments to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the employments to fetch"},{"name":"employee_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID for employees to fetch employments for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Employee Id"},"description":"The ID for employees to fetch employments for"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"employment_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The type of the employment to filter by","examples":["FULL_TIME","PART_TIME","INTERN","CONTRACTOR","FREELANCE","REGULAR","FURLOUGHED","TERMINATED","-"],"title":"Employment Type"},"description":"The type of the employment to filter by"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisEmployment_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/employments/{id}":{"get":{"tags":["Employments"],"summary":"Get Employment By Id","description":"Returns an Employment object with the given id.","operationId":"get_employment_by_id_api_hris_v1_employments__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisEmployment"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/groups":{"get":{"tags":["Group"],"summary":"Get Groups","description":"Returns a list of Group objects.","operationId":"get_groups_api_hris_v1_groups_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the groups to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the groups to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"parent_group_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the parent group to filter by","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Parent Group Id"},"description":"The ID of the parent group to filter by"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The type of the group to filter by","examples":["COST_CENTER","DEPARTMENT","BUSINESS_UNIT","DIVISION","TEAM"],"title":"Type"},"description":"The type of the group to filter by"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisGroup_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/groups/{id}":{"get":{"tags":["Group"],"summary":"Get Group By Id","description":"Returns a Group object with the given id.","operationId":"get_group_by_id_api_hris_v1_groups__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisGroup"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/pay-groups":{"get":{"tags":["Pay Groups"],"summary":"Get Pay Groups","description":"Returns a list of PayGroup objects.","operationId":"get_pay_groups_api_hris_v1_pay_groups_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the pay groups to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the pay groups to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisPayGroup_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/pay-groups/{id}":{"get":{"tags":["Pay Groups"],"summary":"Get Pay Group By Id","description":"Returns a PayGroup object with the given id.","operationId":"get_pay_group_by_id_api_hris_v1_pay_groups__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisPayGroup"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/payroll-runs":{"get":{"tags":["Payroll Runs"],"summary":"Get Payroll Runs","description":"Returns a list of PayrollRun objects.","operationId":"get_payroll_runs_api_hris_v1_payroll_runs_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the payroll runs to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the payroll runs to fetch"},{"name":"run_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The type of the payroll run Possible values include: REGULAR, \n        OFF_CYCLE, CORRECTION, TERMINATION, SIGN_ON_BONUS. In cases where there is \n        no clear mapping, the original value passed through will be returned.","examples":["REGULAR"],"title":"Run Type"},"description":"The type of the payroll run Possible values include: REGULAR, \n        OFF_CYCLE, CORRECTION, TERMINATION, SIGN_ON_BONUS. In cases where there is \n        no clear mapping, the original value passed through will be returned."},{"name":"run_state","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The state of the payroll run Possible values include: PAID, \n        DRAFT, APPROVED, FAILED, CLOSED. In cases where there is no clear mapping, \n        the original value passed through will be returned.","examples":["PAID"],"title":"Run State"},"description":"The state of the payroll run Possible values include: PAID, \n        DRAFT, APPROVED, FAILED, CLOSED. In cases where there is no clear mapping, \n        the original value passed through will be returned."},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"pay_group_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the pay group to filter by","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Pay Group Id"},"description":"The ID of the pay group to filter by"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"start_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Start Date From"},"description":"If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"start_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Start Date To"},"description":"If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"end_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"End Date From"},"description":"If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"end_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"End Date To"},"description":"If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"check_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with check_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Check Date From"},"description":"If provided, only objects with check_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"check_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with check_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Check Date To"},"description":"If provided, only objects with check_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisPayrollRun_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/payroll-runs/{id}":{"get":{"tags":["Payroll Runs"],"summary":"Get Payroll Run By Id","description":"Returns a PayrollRun object with the given id.","operationId":"get_payroll_run_by_id_api_hris_v1_payroll_runs__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisPayrollRun"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/payroll-codes":{"get":{"tags":["Payroll Codes"],"summary":"Get Payroll Codes","description":"Returns a list of Payroll Code objects.","operationId":"get_payroll_codes_api_hris_v1_payroll_codes_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the payroll codes to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the payroll codes to fetch"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The type of payroll code to filter by (e.g., Earning, Deduction, Tax).","examples":["EARNING","DEDUCTION","TAX"],"title":"Type"},"description":"The type of payroll code to filter by (e.g., Earning, Deduction, Tax)."},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisPayrollCode_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/payroll-codes/{id}":{"get":{"tags":["Payroll Codes"],"summary":"Get Payroll Code By Id","description":"Returns a Payroll Code object with the given id.","operationId":"get_payroll_code_by_id_api_hris_v1_payroll_codes__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisPayrollCode"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/payroll-run-calendars":{"get":{"tags":["Payroll Run Calendars"],"summary":"Get Payroll Run Calendars","description":"Returns a list of PayrollRunCalendar objects.","operationId":"get_payroll_run_calendars_api_hris_v1_payroll_run_calendars_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the payroll run calendars to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the payroll run calendars to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisPayrollRunCalendar_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/payroll-run-calendars/{id}":{"get":{"tags":["Payroll Run Calendars"],"summary":"Get Payroll Calendar Run By Id","description":"Returns a PayrollRunCalendar object with the given id.","operationId":"get_payroll_calendar_run_by_id_api_hris_v1_payroll_run_calendars__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisPayrollRunCalendar"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/employee-payroll-runs":{"get":{"tags":["Employee Payroll Runs"],"summary":"Get Employee Payroll Runs","description":"Returns a list of EmployeePayrollRun objects.","operationId":"get_employee_payroll_runs_api_hris_v1_employee_payroll_runs_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the employee payroll runs to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the employee payroll runs to fetch"},{"name":"employee_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the employees to fetch employee payroll run for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Employee Id"},"description":"The ID of the employees to fetch employee payroll run for"},{"name":"payroll_run_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The IDs of the payroll runs to fetch employee payroll run for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Payroll Run Id"},"description":"The IDs of the payroll runs to fetch employee payroll run for"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"start_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Start Date From"},"description":"If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"start_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Start Date To"},"description":"If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"end_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"End Date From"},"description":"If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"end_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"End Date To"},"description":"If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"check_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with check_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Check Date From"},"description":"If provided, only objects with check_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"check_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with check_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Check Date To"},"description":"If provided, only objects with check_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisEmployeePayrollRun_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Employee Payroll Runs"],"summary":"Create Employee Payroll Run","description":"Creates a Employee Payroll Run object with the given values.","operationId":"create_employee_payroll_run_api_hris_v1_employee_payroll_runs_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-idempotency-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Key to guarantee idempotent write execution.","title":"X-Idempotency-Key"},"description":"Key to guarantee idempotent write execution."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/employee-payroll-runs/meta/post":{"get":{"tags":["Employee Payroll Runs"],"summary":"Get Create Employee Payroll Run Meta","description":"Returns request schema for POST Employee Payroll Run request.","operationId":"get_create_employee_payroll_run_meta_api_hris_v1_employee_payroll_runs_meta_post_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Create Employee Payroll Run Meta Api Hris V1 Employee Payroll Runs Meta Post Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/employee-payroll-runs/{id}":{"get":{"tags":["Employee Payroll Runs"],"summary":"Get Employee Payroll Runs By Id","description":"Returns an EmployeePayrollRun object with the given id","operationId":"get_employee_payroll_runs_by_id_api_hris_v1_employee_payroll_runs__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisEmployeePayrollRun"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/time-off":{"get":{"tags":["Time Off"],"summary":"Get Time Off List","description":"Returns a list of TimeOff objects.","operationId":"get_time_off_list_api_hris_v1_time_off_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the time offs to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the time offs to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"employee_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the employees to fetch time offs for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Employee Id"},"description":"The ID of the employees to fetch time offs for"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The status of the time off to filter by","examples":["REQUESTED","APPROVED","DECLINED","CANCELLED","DELETED"],"title":"Status"},"description":"The status of the time off to filter by"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisTimeOff_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Time Off"],"summary":"Create Time Off","description":"Creates a TimeOff object with the given values.","operationId":"create_time_off_api_hris_v1_time_off_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-idempotency-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Key to guarantee idempotent write execution.","title":"X-Idempotency-Key"},"description":"Key to guarantee idempotent write execution."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/time-off/meta/post":{"get":{"tags":["Time Off"],"summary":"Get Create Time Off Meta","description":"Returns request schema for POST Time off request.","operationId":"get_create_time_off_meta_api_hris_v1_time_off_meta_post_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Create Time Off Meta Api Hris V1 Time Off Meta Post Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/time-off/{id}":{"get":{"tags":["Time Off"],"summary":"Get Time Off By Id","description":"Returns a TimeOff object with the given id.","operationId":"get_time_off_by_id_api_hris_v1_time_off__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisTimeOff"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/time-off-balances":{"get":{"tags":["Time Off Balance"],"summary":"Get Time Off Balances List","description":"Returns a list of TimeOffBalance objects.","operationId":"get_time_off_balances_list_api_hris_v1_time_off_balances_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the time off balances to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the time off balances to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"employee_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the employees to fetch time off balance for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Employee Id"},"description":"The ID of the employees to fetch time off balance for"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisTimeOffBalance_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/time-off-balances/{id}":{"get":{"tags":["Time Off Balance"],"summary":"Get Time Off Balance By Id","description":"Returns a TimeOffBalance object with the given id.","operationId":"get_time_off_balance_by_id_api_hris_v1_time_off_balances__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisTimeOffBalance"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/compensations":{"get":{"tags":["Compensation"],"summary":"Get Compensations","description":"Returns a list of Compensation objects.","operationId":"get_compensations_api_hris_v1_compensations_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the compensations to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the compensations to fetch"},{"name":"employee_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the employees to fetch compensation for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Employee Id"},"description":"The ID of the employees to fetch compensation for"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"pay_group_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the pay groups to fetch compensation for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Pay Group Id"},"description":"The ID of the pay groups to fetch compensation for"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"start_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Start Date From"},"description":"If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"start_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Start Date To"},"description":"If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisCompensation_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/compensations/{id}":{"get":{"tags":["Compensation"],"summary":"Get Compensation By Id","description":"Returns a Compensation object with the given id.","operationId":"get_compensation_by_id_api_hris_v1_compensations__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisCompensation"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/timesheet-entry":{"get":{"tags":["Timesheet Entry"],"summary":"Get Timesheet List","description":"Returns a list of Timesheet entry objects.","operationId":"get_timesheet_list_api_hris_v1_timesheet_entry_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the timesheet entries to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the timesheet entries to fetch"},{"name":"employee_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the employees to fetch timesheet entries for","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Employee Id"},"description":"The ID of the employees to fetch timesheet entries for"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"start_time_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return objects with start time same or after this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2023-10-01T00:00:00Z"],"title":"Start Time From"},"description":"If provided, will only return objects with start time same or after this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"start_time_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return objects with start time same or before this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2023-10-31T23:59:59Z"],"title":"Start Time To"},"description":"If provided, will only return objects with start time same or before this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"end_time_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return objects with end time same or after this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2023-10-01T00:00:00Z"],"title":"End Time From"},"description":"If provided, will only return objects with end time same or after this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"end_time_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return objects with end time same or before this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2023-10-31T23:59:59Z"],"title":"End Time To"},"description":"If provided, will only return objects with end time same or before this value. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisTimeSheetEntry_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Timesheet Entry"],"summary":"Create Timesheet","description":"Creates a Time sheet object with the given values.","operationId":"create_timesheet_api_hris_v1_timesheet_entry_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-idempotency-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Key to guarantee idempotent write execution.","title":"X-Idempotency-Key"},"description":"Key to guarantee idempotent write execution."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/timesheet-entry/meta/post":{"get":{"tags":["Timesheet Entry"],"summary":"Get Create Timesheet Meta","description":"Returns request schema for POST Timesheet entry request.","operationId":"get_create_timesheet_meta_api_hris_v1_timesheet_entry_meta_post_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Create Timesheet Meta Api Hris V1 Timesheet Entry Meta Post Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/timesheet-entry/{id}":{"get":{"tags":["Timesheet Entry"],"summary":"Get Timesheet By Id","description":"Returns a Timesheet object with the given id.","operationId":"get_timesheet_by_id_api_hris_v1_timesheet_entry__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisTimeSheetEntry"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/connectors":{"get":{"tags":["Connector"],"summary":"Get Hris Connectors","description":"Returns a list of HRIS connectors","operationId":"get_hris_connectors_api_hris_v1_connectors_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"connector_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The connector token for the connector","examples":["i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"],"title":"Connector Token"},"description":"The connector token for the connector"},{"name":"is_active","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter connectors by active status","examples":[true],"title":"Is Active"},"description":"Filter connectors by active status"},{"name":"origin_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter connectors by end user origin ID","examples":["user_123"],"title":"Origin Id"},"description":"Filter connectors by end user origin ID"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisConnectorResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/connectors/{connector_id}/delete":{"delete":{"tags":["Connector"],"summary":"Delete Hris Connector","description":"Deletes the provided connector","operationId":"delete_hris_connector_api_hris_v1_connectors__connector_id__delete_delete","security":[{"HTTPBearer":[]}],"parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessageResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/integrations":{"get":{"tags":["Integration"],"summary":"Get Org Integrations","description":"Returns a list of Integrations","operationId":"get_org_integrations_api_hris_v1_integrations_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_IntegrationResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/locations":{"get":{"tags":["Location"],"summary":"Get Locations","description":"Returns a list of Location objects.","operationId":"get_locations_api_hris_v1_locations_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of locations to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of locations to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_HrisLocation_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/hris/v1/locations/{id}":{"get":{"tags":["Location"],"summary":"Get Location By Id","description":"Returns a Location object with the given id.","operationId":"get_location_by_id_api_hris_v1_locations__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HrisLocation"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/activities":{"get":{"tags":["Activity"],"summary":"Get Activities","description":"Returns a list of Activity objects.","operationId":"get_activities_api_ats_v1_activities_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the activities to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the activities to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"user","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The user ids of the users triggering activity","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"User"},"description":"The user ids of the users triggering activity"},{"name":"candidate","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate ids concerning the activity.","examples":["01932bf2-b8bc-7bc0-bef0-1a7e2971ec31,01931edf-04b6-7391-8a5c-93ac4b395316"],"title":"Candidate"},"description":"The candidate ids concerning the activity."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsActivity_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Activity"],"summary":"Create Activity","description":"Creates a Activity object with the given values.","operationId":"create_activity_api_ats_v1_activities_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAtsActivity"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/activities/{id}":{"get":{"tags":["Activity"],"summary":"Get Activity By Id","description":"Returns a Activity object with the given id.","operationId":"get_activity_by_id_api_ats_v1_activities__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsActivity"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/applications":{"get":{"tags":["Application"],"summary":"Get Applications","description":"Returns a list of Application objects.","operationId":"get_applications_api_ats_v1_applications_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the applications to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the applications to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"current_stage","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The current stage ids of the application","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Current Stage"},"description":"The current stage ids of the application"},{"name":"credited_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The user ids which has the credit for the applications to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Credited To"},"description":"The user ids which has the credit for the applications to fetch"},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The source of the application","examples":["Linkedin"],"title":"Source"},"description":"The source of the application"},{"name":"job","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The job ids for the applications to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Job"},"description":"The job ids for the applications to fetch"},{"name":"candidate","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate ids for the applications to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Candidate"},"description":"The candidate ids for the applications to fetch"},{"name":"reject_reason","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reject reason ids for the applications to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Reject Reason"},"description":"The reject reason ids for the applications to fetch"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsApplication_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Application"],"summary":"Create Application","description":"Creates an Application object with the given values.","operationId":"create_application_api_ats_v1_applications_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Create Application Api Ats V1 Applications Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/applications/{id}":{"get":{"tags":["Application"],"summary":"Get Application By Id","description":"Returns an Application object with the given id.","operationId":"get_application_by_id_api_ats_v1_applications__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsApplication"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/attachments":{"get":{"tags":["Attachment"],"summary":"Get Attachments","description":"Returns a list of Attachment objects.","operationId":"get_attachments_api_ats_v1_attachments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the attachments to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the attachments to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"candidate","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidate ids for the attachments to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Candidate"},"description":"The candidate ids for the attachments to fetch"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsAttachment_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Attachment"],"summary":"Create Attachment","description":"Creates an Attachment object with the given values.","operationId":"create_attachment_api_ats_v1_attachments_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Create Attachment Api Ats V1 Attachments Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/attachments/{id}":{"get":{"tags":["Attachment"],"summary":"Get Attachment By Id","description":"Returns an Attachment object with the given id.","operationId":"get_attachment_by_id_api_ats_v1_attachments__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsAttachment"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/candidates":{"get":{"tags":["Candidate"],"summary":"Get Candidates","description":"Returns a list of Candidate objects.","operationId":"get_candidates_api_ats_v1_candidates_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the candidates to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the candidates to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"company","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return candidate for these companies","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Company"},"description":"If provided, will only return candidate for these companies"},{"name":"first_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will return candidates with this first name","examples":["John"],"title":"First Name"},"description":"If provided, will return candidates with this first name"},{"name":"last_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will return candidates with this last name","examples":["Kremlin"],"title":"Last Name"},"description":"If provided, will return candidates with this last name"},{"name":"tag","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will return candidates with this tag","examples":["Tech Experience"],"title":"Tag"},"description":"If provided, will return candidates with this tag"},{"name":"email_addresses","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"If provided, will return candidates with these email addresses","examples":["john@doe.com","jane@doe.com"],"title":"Email Addresses"},"description":"If provided, will return candidates with these email addresses"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsCandidate_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Candidate"],"summary":"Create Candidate","description":"Creates a Candidate object with the given values.","operationId":"create_candidate_api_ats_v1_candidates_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CreateCandidate"},{"$ref":"#/components/schemas/AtsCandidateWrite"}],"title":"Candidate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/candidates/create/meta":{"get":{"tags":["Candidate"],"summary":"Get Create Candidate Request Body","description":"Returns the data points required to add new employee in HRIS","operationId":"get_create_candidate_request_body_api_ats_v1_candidates_create_meta_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetaApiResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/candidates/{id}":{"get":{"tags":["Candidate"],"summary":"Get Candidate By Id","description":"Returns a Candidate object with the given id.","operationId":"get_candidate_by_id_api_ats_v1_candidates__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsCandidate"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/candidates/{candidate_id}/attachments":{"post":{"tags":["Candidate"],"summary":"Create Candidate Attachment","description":"Uploads an attachment for a given candidate.","operationId":"create_candidate_attachment_api_ats_v1_candidates__candidate_id__attachments_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"candidate_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Candidate Id"}},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsAttachmentWrite"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/departments":{"get":{"tags":["Department"],"summary":"Get Departments","description":"Returns a list of Department objects.","operationId":"get_departments_api_ats_v1_departments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the departments to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the departments to fetch"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsDepartment_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Department"],"summary":"Create Department","description":"Creates a Department object with the given values.","operationId":"create_department_api_ats_v1_departments_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Create Department Api Ats V1 Departments Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/departments/{id}":{"get":{"tags":["Department"],"summary":"Get Department By Id","description":"Returns a Department object with the given id.","operationId":"get_department_by_id_api_ats_v1_departments__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsDepartment"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/eeocs":{"get":{"tags":["EEOC"],"summary":"Get Eeocs","description":"Returns a list of EEOC records.","operationId":"get_eeocs_api_ats_v1_eeocs_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the eeocs to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the eeocs to fetch"},{"name":"candidate","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The candidates id for the eeocs to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Candidate"},"description":"The candidates id for the eeocs to fetch"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsEEOC_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["EEOC"],"summary":"Create Eeoc","description":"Creates an EEOC record with the given values.","operationId":"create_eeoc_api_ats_v1_eeocs_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Create Eeoc Api Ats V1 Eeocs Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/eeocs/{id}":{"get":{"tags":["EEOC"],"summary":"Get Eeoc By Id","description":"Returns an EEOC record with the given id.","operationId":"get_eeoc_by_id_api_ats_v1_eeocs__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsEEOC"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/job-interview-stages":{"get":{"tags":["Job Interview Stage"],"summary":"Get Job Interview Stages","description":"Returns a list of Job Interview Stage objects.","operationId":"get_job_interview_stages_api_ats_v1_job_interview_stages_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the job interview stages to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the job interview stages to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"type":"string","description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"job","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Return the stages for the given job ids","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Job"},"description":"Return the stages for the given job ids"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsJobInterviewStage_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Job Interview Stage"],"summary":"Create Job Interview Stage","description":"Creates a Job Interview Stage object with the given values.","operationId":"create_job_interview_stage_api_ats_v1_job_interview_stages_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Create Job Interview Stage Api Ats V1 Job Interview Stages Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/job-interview-stages/{id}":{"get":{"tags":["Job Interview Stage"],"summary":"Get Job Interview Stage By Id","description":"Returns a Job Interview Stage object with the given id.","operationId":"get_job_interview_stage_by_id_api_ats_v1_job_interview_stages__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsJobInterviewStage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/jobs":{"get":{"tags":["Job"],"summary":"Get Jobs","description":"Returns a list of Job objects.","operationId":"get_jobs_api_ats_v1_jobs_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the jobs to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the jobs to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will return jobs with this code","examples":["DEV-01"],"title":"Code"},"description":"If provided, will return jobs with this code"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will return jobs with this status. Along with the standard values, any connector specific value returned in the response can be passed as well.","examples":["OPEN","CLOSED","DRAFT","ARCHIVED","PENDING","-"],"title":"Status"},"description":"If provided, will return jobs with this status. Along with the standard values, any connector specific value returned in the response can be passed as well."},{"name":"offices","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will return jobs in these offices","examples":["0194bcb7-bf3e-7315-8628-0dc9bf1b6d92,0194bcb7-bf3e-7315-8628-0dc9bf1b6d92"],"title":"Offices"},"description":"If provided, will return jobs in these offices"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsJob_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Job"],"summary":"Create Job","description":"Creates a Job object with the given values.","operationId":"create_job_api_ats_v1_jobs_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAtsJob"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/jobs/{id}":{"get":{"tags":["Job"],"summary":"Get Job By Id","description":"Returns a Job object with the given id.","operationId":"get_job_by_id_api_ats_v1_jobs__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsJob"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/offers":{"get":{"tags":["Offer"],"summary":"Get Offers","description":"Returns a list of Offer objects.","operationId":"get_offers_api_ats_v1_offers_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the offers to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the offers to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"application","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The application id of the offer","examples":["0194bcb7-bf3e-7315-8628-0dc9bf1b6d92"],"title":"Application"},"description":"The application id of the offer"},{"name":"creator","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The creator for the offers to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Creator"},"description":"The creator for the offers to fetch"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsOffer_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Offer"],"summary":"Create Offer","description":"Creates an Offer object with the given values.","operationId":"create_offer_api_ats_v1_offers_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Create Offer Api Ats V1 Offers Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/offers/{id}":{"get":{"tags":["Offer"],"summary":"Get Offer By Id","description":"Returns an Offer object with the given id.","operationId":"get_offer_by_id_api_ats_v1_offers__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsOffer"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/offices":{"get":{"tags":["Office"],"summary":"Get Offices","description":"Returns a list of Office objects.","operationId":"get_offices_api_ats_v1_offices_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the offices to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the offices to fetch"},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","examples":["3235005483341316245"],"title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsOffice_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Office"],"summary":"Create Office","description":"Creates an Office object with the given values.","operationId":"create_office_api_ats_v1_offices_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Create Office Api Ats V1 Offices Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/offices/{id}":{"get":{"tags":["Office"],"summary":"Get Office By Id","description":"Returns an Office object with the given id.","operationId":"get_office_by_id_api_ats_v1_offices__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsOffice"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/reject-reasons":{"get":{"tags":["Reject Reason"],"summary":"Get Reject Reasons","description":"Returns a list of RejectReason objects.","operationId":"get_reject_reasons_api_ats_v1_reject_reasons_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the reject reasons to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the reject reasons to fetch"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsRejectReason_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Reject Reason"],"summary":"Create Reject Reason","description":"Creates a RejectReason object with the given values.","operationId":"create_reject_reason_api_ats_v1_reject_reasons_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Create Reject Reason Api Ats V1 Reject Reasons Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/reject-reasons/{id}":{"get":{"tags":["Reject Reason"],"summary":"Get Reject Reason By Id","description":"Returns a RejectReason object with the given id.","operationId":"get_reject_reason_by_id_api_ats_v1_reject_reasons__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsRejectReason"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/remote-users":{"get":{"tags":["Remote User"],"summary":"Get Remote Users","description":"Returns a list of RemoteUser objects.","operationId":"get_remote_users_api_ats_v1_remote_users_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the remote users to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the remote users to fetch"},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Email id of the user","examples":["john@doe.com"],"title":"Email"},"description":"Email id of the user"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsRemoteUser_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Remote User"],"summary":"Create Remote User","description":"Creates a RemoteUser object with the given values.","operationId":"create_remote_user_api_ats_v1_remote_users_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Create Remote User Api Ats V1 Remote Users Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/remote-users/{id}":{"get":{"tags":["Remote User"],"summary":"Get Remote User By Id","description":"Returns a RemoteUser object with the given id.","operationId":"get_remote_user_by_id_api_ats_v1_remote_users__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsRemoteUser"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/scheduled-interviews":{"get":{"tags":["Scheduled Interview"],"summary":"Get Scheduled Interviews","description":"Returns a list of ScheduledInterview objects.","operationId":"get_scheduled_interviews_api_ats_v1_scheduled_interviews_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the scheduled interviews to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the scheduled interviews to fetch"},{"name":"application","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Application id of the scheduled interview","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Application"},"description":"Application id of the scheduled interview"},{"name":"organizer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"User id of the organizers for the scheduled interview to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Organizer"},"description":"User id of the organizers for the scheduled interview to fetch"},{"name":"job_interview_stage","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Job interview stage id of the scheduled interviews","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Job Interview Stage"},"description":"Job interview stage id of the scheduled interviews"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsScheduledInterview_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Scheduled Interview"],"summary":"Create Scheduled Interview","description":"Creates a ScheduledInterview object with the given values.","operationId":"create_scheduled_interview_api_ats_v1_scheduled_interviews_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Create Scheduled Interview Api Ats V1 Scheduled Interviews Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/scheduled-interviews/{id}":{"get":{"tags":["Scheduled Interview"],"summary":"Get Scheduled Interview By Id","description":"Returns a ScheduledInterview object with the given id.","operationId":"get_scheduled_interview_by_id_api_ats_v1_scheduled_interviews__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsScheduledInterview"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/scorecards":{"get":{"tags":["Scorecard"],"summary":"Get Scorecards","description":"Returns a list of Scorecard objects.","operationId":"get_scorecards_api_ats_v1_scorecards_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the scorecards to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the scorecards to fetch"},{"name":"application","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The application id for the scorecard","examples":["0194bcb7-bf3e-7315-8628-0dc9bf1b6d92"],"title":"Application"},"description":"The application id for the scorecard"},{"name":"interview","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The interview ids for the scorecards to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Interview"},"description":"The interview ids for the scorecards to fetch"},{"name":"interviewer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The interviewer ids for the scorecards to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Interviewer"},"description":"The interviewer ids for the scorecards to fetch"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsScorecard_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Scorecard"],"summary":"Create Scorecard","description":"Creates a Scorecard object with the given values.","operationId":"create_scorecard_api_ats_v1_scorecards_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Create Scorecard Api Ats V1 Scorecards Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/scorecards/{id}":{"get":{"tags":["Scorecard"],"summary":"Get Scorecard By Id","description":"Returns a Scorecard object with the given id.","operationId":"get_scorecard_by_id_api_ats_v1_scorecards__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsScorecard"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/screening-questions":{"get":{"tags":["Screening Question"],"summary":"Get Screening Questions","description":"Returns a list of ScreeningQuestion objects.","operationId":"get_screening_questions_api_ats_v1_screening_questions_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the screening questions to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the screening questions to fetch"},{"name":"job","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The job ids for the screening questions to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Job"},"description":"The job ids for the screening questions to fetch"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsScreeningQuestion_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Screening Question"],"summary":"Create Screening Question","description":"Creates a ScreeningQuestion object with the given values.","operationId":"create_screening_question_api_ats_v1_screening_questions_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Create Screening Question Api Ats V1 Screening Questions Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/screening-questions/{id}":{"get":{"tags":["Screening Question"],"summary":"Get Screening Question By Id","description":"Returns a ScreeningQuestion object with the given id.","operationId":"get_screening_question_by_id_api_ats_v1_screening_questions__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsScreeningQuestion"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/tags":{"get":{"tags":["Tag"],"summary":"Get Tags","description":"Returns a list of Tag objects.","operationId":"get_tags_api_ats_v1_tags_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ID of the tags to fetch","examples":["01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"],"title":"Ids"},"description":"The ID of the tags to fetch"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"modified_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Modified After"},"description":"If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_AtsTag_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"tags":["Tag"],"summary":"Create Tag","description":"Creates a Tag object with the given values.","operationId":"create_tag_api_ats_v1_tags_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Create Tag Api Ats V1 Tags Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/tags/{id}":{"get":{"tags":["Tag"],"summary":"Get Tag By Id","description":"Returns a Tag object with the given id.","operationId":"get_tag_by_id_api_ats_v1_tags__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Include raw data in the response","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Include raw data in the response"},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AtsTag"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/connectors":{"get":{"tags":["Connector"],"summary":"Get Ats Connectors","description":"Returns a list of ATS connectors","operationId":"get_ats_connectors_api_ats_v1_connectors_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"connector_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The connector token for the connector","examples":["i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"],"title":"Connector Token"},"description":"The connector token for the connector"},{"name":"is_active","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter connectors by active status","examples":[true],"title":"Is Active"},"description":"Filter connectors by active status"},{"name":"origin_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter connectors by end user origin ID","examples":["user_123"],"title":"Origin Id"},"description":"Filter connectors by end user origin ID"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ConnectorResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/connectors/{connector_id}/delete":{"delete":{"tags":["Connector"],"summary":"Delete Ats Connector","description":"Deletes the provided connector","operationId":"delete_ats_connector_api_ats_v1_connectors__connector_id__delete_delete","security":[{"HTTPBearer":[]}],"parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessageResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/ats/v1/integrations":{"get":{"tags":["Integration"],"summary":"Get Org Integrations","description":"Returns a list of Integrations","operationId":"get_org_integrations_api_ats_v1_integrations_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_IntegrationResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/users":{"get":{"tags":["Users"],"summary":"Get Lms Users","description":"Returns a list of LMS User objects.","operationId":"get_lms_users_api_lms_v1_users_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return users for these IDs.","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"Ids"},"description":"If provided, will only return users for these IDs."},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"email_address","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return users for this email address.","examples":["john@doe.com"],"title":"Email Address"},"description":"If provided, will only return users for this email address."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return enrollments for this status. Along with the standard values, any connector specific value returned in the response can be passed as well.","examples":["ACTIVE","PENDING","INACTIVE"],"title":"Status"},"description":"If provided, will only return enrollments for this status. Along with the standard values, any connector specific value returned in the response can be passed as well."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_LmsUser_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/users/{id}":{"get":{"tags":["Users"],"summary":"Get Lms User By Id","description":"Returns an LMS User object with the given id.","operationId":"get_lms_user_by_id_api_lms_v1_users__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LmsUser"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/courses":{"get":{"tags":["Courses"],"summary":"Get Lms Courses","description":"Returns a list of LMS Course objects.","operationId":"get_lms_courses_api_lms_v1_courses_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return courses with this status. Along with the standard values, any connector specific value returned in the response can be passed as well.","examples":["ACTIVE","PENDING","INACTIVE"],"title":"Status"},"description":"If provided, will only return courses with this status. Along with the standard values, any connector specific value returned in the response can be passed as well."},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return courses with these IDs","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"Ids"},"description":"If provided, will only return courses with these IDs"},{"name":"categories","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will return courses with these categories","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"],"title":"Categories"},"description":"If provided, will return courses with these categories"},{"name":"skills","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will return courses with these skills","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"Skills"},"description":"If provided, will return courses with these skills"},{"name":"instructors","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will return courses with these instructors","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"Instructors"},"description":"If provided, will return courses with these instructors"},{"name":"contents","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will return courses with these contents","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"Contents"},"description":"If provided, will return courses with these contents"},{"name":"languages","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will return courses with these languages","examples":["en_US,en_UK"],"title":"Languages"},"description":"If provided, will return courses with these languages"},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_LmsCourse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/courses/{id}":{"get":{"tags":["Courses"],"summary":"Get Lms Course By Id","description":"Returns an LMS Course object with the given id.","operationId":"get_lms_course_by_id_api_lms_v1_courses__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LmsCourse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/contents":{"get":{"tags":["Contents"],"summary":"Get Lms Contents","description":"Returns a list of LMS Content objects.","operationId":"get_lms_contents_api_lms_v1_contents_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return contents for these IDs.","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"Ids"},"description":"If provided, will only return contents for these IDs."},{"name":"courses","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return contents for these courses.","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"Courses"},"description":"If provided, will only return contents for these courses."},{"name":"skills","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return contents for these skills.","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"],"title":"Skills"},"description":"If provided, will only return contents for these skills."},{"name":"categories","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return contents for these categories.","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"],"title":"Categories"},"description":"If provided, will only return contents for these categories."},{"name":"languages","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return contents for these languages.","examples":["en_US,en_UK"],"title":"Languages"},"description":"If provided, will only return contents for these languages."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return contents for this status. Along with the standard values, any connector specific value returned in the response can be passed as well.","examples":["ACTIVE","PENDING","INACTIVE"],"title":"Status"},"description":"If provided, will only return contents for this status. Along with the standard values, any connector specific value returned in the response can be passed as well."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_LmsContent_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/contents/{id}":{"get":{"tags":["Contents"],"summary":"Get Lms Content By Id","description":"Returns an LMS Content object with the given id.","operationId":"get_lms_content_by_id_api_lms_v1_contents__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LmsContent"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/skills":{"get":{"tags":["Skills"],"summary":"Get Lms Skills","description":"Returns a list of LMS Skill objects.","operationId":"get_lms_skills_api_lms_v1_skills_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return skills for these IDs.","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"Ids"},"description":"If provided, will only return skills for these IDs."},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return skills with this status. Along with the standard values, any connector specific value returned in the response can be passed as well.","examples":["ACTIVE","PENDING","INACTIVE"],"title":"Status"},"description":"If provided, will only return skills with this status. Along with the standard values, any connector specific value returned in the response can be passed as well."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_LmsSkill_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/skills/{id}":{"get":{"tags":["Skills"],"summary":"Get Lms Skill By Id","description":"Returns an LMS Skill object with the given id.","operationId":"get_lms_skill_by_id_api_lms_v1_skills__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LmsSkill"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/categories":{"get":{"tags":["Categories"],"summary":"Get Lms Categories","description":"Returns a list of LMS Category objects.","operationId":"get_lms_categories_api_lms_v1_categories_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A comma-separated list of LMS Category IDs to filter by.","title":"Ids"},"description":"A comma-separated list of LMS Category IDs to filter by."},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return categories with this status. Along with the standard values, any connector specific value returned in the response can be passed as well.","examples":["ACTIVE","PENDING","INACTIVE"],"title":"Status"},"description":"If provided, will only return categories with this status. Along with the standard values, any connector specific value returned in the response can be passed as well."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_LmsCategory_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/categories/{id}":{"get":{"tags":["Categories"],"summary":"Get Lms Category By Id","description":"Returns an LMS Category object with the given id.","operationId":"get_lms_category_by_id_api_lms_v1_categories__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LmsCategory"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/completions":{"get":{"tags":["Completions"],"summary":"Get Lms Completions","description":"Returns a list of LMS Completion objects.","operationId":"get_lms_completions_api_lms_v1_completions_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A comma-separated list of LMS Completion IDs to filter by.","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"Ids"},"description":"A comma-separated list of LMS Completion IDs to filter by."},{"name":"course","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return completions for these courses.","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"Course"},"description":"If provided, will only return completions for these courses."},{"name":"user","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return completions for these users.","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"User"},"description":"If provided, will only return completions for these users."},{"name":"content","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return completions for these contents.","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"Content"},"description":"If provided, will only return completions for these contents."},{"name":"grade","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return completions for this grade. Along with the standard values, any connector specific value returned in the response can be passed as well.","examples":["A","B","C","D","F","PASS","FAIL","-"],"title":"Grade"},"description":"If provided, will only return completions for this grade. Along with the standard values, any connector specific value returned in the response can be passed as well."},{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"started_at_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with started_at same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Started At From"},"description":"If provided, only objects with started_at same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"started_at_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with started_at same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Started At To"},"description":"If provided, only objects with started_at same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"completed_at_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with completed_at same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Completed At From"},"description":"If provided, only objects with completed_at same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"completed_at_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with completed_at same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Completed At To"},"description":"If provided, only objects with completed_at same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_LmsCompletion_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/completions/{id}":{"get":{"tags":["Completions"],"summary":"Get Lms Completion By Id","description":"Returns an LMS Completion object with the given id.","operationId":"get_lms_completion_by_id_api_lms_v1_completions__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LmsCompletion"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/enrollments":{"get":{"tags":["Enrollments"],"summary":"Get Lms Enrollments","description":"Returns a list of LMS Enrollment objects.","operationId":"get_lms_enrollments_api_lms_v1_enrollments_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"remote_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The third-party API ID of the matching object.","title":"Remote Id"},"description":"The third-party API ID of the matching object."},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return enrollments for these IDs.","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"Ids"},"description":"If provided, will only return enrollments for these IDs."},{"name":"user","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return enrollments for these users.","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"User"},"description":"If provided, will only return enrollments for these users."},{"name":"course","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, will only return enrollments for these courses.","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"],"title":"Course"},"description":"If provided, will only return enrollments for these courses."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"start_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Start Date From"},"description":"If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"start_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Start Date To"},"description":"If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"end_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"End Date From"},"description":"If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"end_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"End Date To"},"description":"If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_LmsEnrollment_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/enrollments/{id}":{"get":{"tags":["Enrollments"],"summary":"Get Lms Enrollment By Id","description":"Returns an LMS Enrollment object with the given id.","operationId":"get_lms_enrollment_by_id_api_lms_v1_enrollments__id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Id"}},{"name":"include_raw_data","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the original data Bindbee fetched from the third-party to produce these models.","examples":[false],"default":false,"title":"Include Raw Data"},"description":"Whether to include the original data Bindbee fetched from the third-party to produce these models."},{"name":"include_custom_fields","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include custom fields in the response.","examples":[false],"default":false,"title":"Include Custom Fields"},"description":"Whether to include custom fields in the response."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.","examples":["manager[first_name,last_name]"],"title":"Expand"},"description":"Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name."},{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LmsEnrollment"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/connectors":{"get":{"tags":["Connector"],"summary":"Get Lms Connectors","description":"Returns a list of LMS connectors","operationId":"get_lms_connectors_api_lms_v1_connectors_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"connector_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The connector token for the connector","examples":["i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"],"title":"Connector Token"},"description":"The connector token for the connector"},{"name":"is_active","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter connectors by active status","examples":[true],"title":"Is Active"},"description":"Filter connectors by active status"},{"name":"origin_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter connectors by end user origin ID","examples":["user_123"],"title":"Origin Id"},"description":"Filter connectors by end user origin ID"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ConnectorResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/connectors/{connector_id}/delete":{"delete":{"tags":["Connector"],"summary":"Delete Lms Connector","description":"Deletes the provided connector","operationId":"delete_lms_connector_api_lms_v1_connectors__connector_id__delete_delete","security":[{"HTTPBearer":[]}],"parameters":[{"name":"connector_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Connector Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessMessageResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lms/v1/integrations":{"get":{"tags":["Integration"],"summary":"Get Org Integrations","description":"Returns a list of Integrations","operationId":"get_org_integrations_api_lms_v1_integrations_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_IntegrationResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/org-check":{"post":{"tags":["Health Check"],"summary":"Org Health Check","operationId":"org_health_check_api_v1_org_check_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/passthrough":{"post":{"tags":["Passthrough"],"summary":"Make Passthrough Request","operationId":"make_passthrough_request_api_v1_passthrough_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PassThroughRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/custom-fields":{"post":{"tags":["Custom Fields"],"summary":"Create Custom Field","description":"Create a new custom field.","operationId":"create_custom_field_api_v1_custom_fields_post","security":[{"HTTPBearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldCreateExternal"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Create Custom Field Api V1 Custom Fields Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"tags":["Custom Fields"],"summary":"List Custom Fields","description":"List custom fields for the caller's organization.","operationId":"list_custom_fields_api_v1_custom_fields_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/Category"},{"type":"null"}],"description":"Filter by category, e.g. HRIS.","examples":["HRIS"],"title":"Category"},"description":"Filter by category, e.g. HRIS."},{"name":"model","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9_-]*$"},{"type":"null"}],"description":"Filter by model slug, e.g. employee.","examples":["employee"],"title":"Model"},"description":"Filter by model slug, e.g. employee."},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomFieldSource"},{"type":"null"}],"description":"Filter by origin: 'API' for fields created via the public API, 'DASHBOARD' for fields created from the Bindbee dashboard.","examples":["API"],"title":"Source"},"description":"Filter by origin: 'API' for fields created via the public API, 'DASHBOARD' for fields created from the Bindbee dashboard."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Number of results to return per page. Maximum size is 200.","default":50,"title":"Page Size"},"description":"Number of results to return per page. Maximum size is 200."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_CustomFieldExternal_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/custom-fields/mapping":{"post":{"tags":["Custom Fields"],"summary":"Create Custom Field Mapping","description":"Create a custom field mapping. Provide exactly one of `integration_slug` (organization scope) or `connector_token` (connector scope).","operationId":"create_custom_field_mapping_api_v1_custom_fields_mapping_post","security":[{"HTTPBearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldMappingCreateExternal"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Create Custom Field Mapping Api V1 Custom Fields Mapping Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"tags":["Custom Fields"],"summary":"List Custom Field Mappings","description":"List mappings for an integration slug or connector token. Provide exactly one of `integration_slug` or `connector_token`.","operationId":"list_custom_field_mappings_api_v1_custom_fields_mapping_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"integration_slug","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Integration slug — return organization-scoped mappings for this integration.","examples":["workday"],"title":"Integration Slug"},"description":"Integration slug — return organization-scoped mappings for this integration."},{"name":"connector_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Connector token — return connector-scoped mappings for this connector.","examples":["i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"],"title":"Connector Token"},"description":"Connector token — return connector-scoped mappings for this connector."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldMappingExternal"},"title":"Response List Custom Field Mappings Api V1 Custom Fields Mapping Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/custom-fields/mapping/{custom_field_mapping_id}":{"patch":{"tags":["Custom Fields"],"summary":"Update Custom Field Mapping","description":"Update a custom field mapping (json_path only).","operationId":"update_custom_field_mapping_api_v1_custom_fields_mapping__custom_field_mapping_id__patch","security":[{"HTTPBearer":[]}],"parameters":[{"name":"custom_field_mapping_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Custom Field Mapping Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldMappingUpdateExternal"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldMappingExternal"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Custom Fields"],"summary":"Delete Custom Field Mapping","description":"Delete a custom field mapping.","operationId":"delete_custom_field_mapping_api_v1_custom_fields_mapping__custom_field_mapping_id__delete","security":[{"HTTPBearer":[]}],"parameters":[{"name":"custom_field_mapping_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Custom Field Mapping Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/custom-fields/raw-data":{"get":{"tags":["Custom Fields"],"summary":"Get Raw Data","description":"Inspect the raw upstream payload for a connector + (category, model). Use this to discover the field structure before writing a JMESPath. Returns the latest synced row's raw_data; falls back to the integration's canned sample if the connector has never synced. Provide exactly one of `connector_token` or `integration_slug`.","operationId":"get_raw_data_api_v1_custom_fields_raw_data_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"category","in":"query","required":true,"schema":{"$ref":"#/components/schemas/Category","description":"Category of the model.","examples":["HRIS"]},"description":"Category of the model."},{"name":"model","in":"query","required":true,"schema":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9_-]*$","description":"Model slug whose raw payload should be returned.","examples":["employee"],"title":"Model"},"description":"Model slug whose raw payload should be returned."},{"name":"connector_token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Connector token used to return the connector's latest synced row. Exactly one of `connector_token` or `integration_slug` is required.","examples":["i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"],"title":"Connector Token"},"description":"Connector token used to return the connector's latest synced row. Exactly one of `connector_token` or `integration_slug` is required."},{"name":"integration_slug","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Integration slug used to return the canned integration sample. Exactly one of `connector_token` or `integration_slug` is required.","examples":["workday"],"title":"Integration Slug"},"description":"Integration slug used to return the canned integration sample. Exactly one of `connector_token` or `integration_slug` is required."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","additionalProperties":true},{"type":"null"}],"title":"Response Get Raw Data Api V1 Custom Fields Raw Data Get"}}}},"422":{"description":"Request validation failed. Exactly one of `connector_token` or `integration_slug` must be provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-query-parameter-constraints":{"exactlyOne":["connector_token","integration_slug"]}}},"/api/v1/custom-fields/preview":{"post":{"tags":["Custom Fields"],"summary":"Preview Custom Field","description":"Dry-run a JMESPath against a connector's data, without creating a mapping. Useful for validating an expression before persisting it as a mapping.","operationId":"preview_custom_field_api_v1_custom_fields_preview_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldPreviewRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldPreviewResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/custom-fields/configuration":{"get":{"tags":["Custom Fields"],"summary":"Get Custom Fields Configuration","description":"For a connector + (category, model), return the full custom-field configuration: every custom field with its effective mapping (connector overrides organization) and the source. Unmapped fields are included with null json_path so callers can see what is left to configure.","operationId":"get_custom_fields_configuration_api_v1_custom_fields_configuration_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"connector_token","in":"query","required":true,"schema":{"type":"string","description":"Connector token to compute the configuration for.","examples":["i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"],"title":"Connector Token"},"description":"Connector token to compute the configuration for."},{"name":"category","in":"query","required":true,"schema":{"$ref":"#/components/schemas/Category","description":"Category to filter custom fields by.","examples":["HRIS"]},"description":"Category to filter custom fields by."},{"name":"model","in":"query","required":true,"schema":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9_-]*$","description":"Model slug to filter custom fields by.","examples":["employee"],"title":"Model"},"description":"Model slug to filter custom fields by."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EffectiveCustomFieldResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/custom-fields/{custom_field_id}":{"get":{"tags":["Custom Fields"],"summary":"Get Custom Field","description":"Get a custom field with all its mappings.","operationId":"get_custom_field_api_v1_custom_fields__custom_field_id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"custom_field_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Custom Field Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDetailExternal"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"tags":["Custom Fields"],"summary":"Update Custom Field","description":"Update a custom field. `category` and `model` can only be changed while the field has no mappings.","operationId":"update_custom_field_api_v1_custom_fields__custom_field_id__patch","security":[{"HTTPBearer":[]}],"parameters":[{"name":"custom_field_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Custom Field Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldUpdateExternal"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDetailExternal"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Custom Fields"],"summary":"Delete Custom Field","description":"Delete a custom field.","operationId":"delete_custom_field_api_v1_custom_fields__custom_field_id__delete","security":[{"HTTPBearer":[]}],"parameters":[{"name":"custom_field_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Custom Field Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/lookup/integrations":{"get":{"tags":["Lookup"],"summary":"List Integrations","description":"List integrations enabled for the caller's organization. Each row carries the categories the org has enabled for that integration. Use `slug` as `integration_slug` when creating org-level custom field mappings.","operationId":"list_integrations_api_v1_lookup_integrations_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/Category"},{"type":"null"}],"description":"Filter to integrations the org has enabled for this category.","examples":["HRIS"],"title":"Category"},"description":"Filter to integrations the org has enabled for this category."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/lookup/models":{"get":{"tags":["Lookup"],"summary":"List Models","description":"List unified models enabled for the caller's organization. Use `slug` as `model` when creating custom fields or mappings.","operationId":"list_models_api_v1_lookup_models_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/Category"},{"type":"null"}],"description":"Filter to models in this category.","examples":["HRIS"],"title":"Category"},"description":"Filter to models in this category."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/webhooks":{"get":{"tags":["Webhooks"],"summary":"List Webhooks","description":"List webhooks configured for the caller's organization.","operationId":"list_webhooks_api_v1_webhooks_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"is_active","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter webhooks by active status.","examples":[true],"title":"Is Active"},"description":"Filter webhooks by active status."},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of results to return per page.","default":20,"title":"Page Size"},"description":"Number of results to return per page."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_WebhookListItemExternal_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/webhooks/logs":{"get":{"tags":["Webhooks"],"summary":"List Webhook Logs","description":"List webhook delivery attempts for the caller's organization. Filter by `webhook_id` (see `GET /webhooks` for available ids) or `connector_id` to narrow the results.","operationId":"list_webhook_logs_api_v1_webhooks_logs_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"description":"Number of results to return per page.","default":25,"title":"Page Size"},"description":"Number of results to return per page."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The pagination cursor value.","title":"Cursor"},"description":"The pagination cursor value."},{"name":"webhook_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Restrict results to deliveries for this webhook.","title":"Webhook Id"},"description":"Restrict results to deliveries for this webhook."},{"name":"connector_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Restrict results to deliveries triggered for this connector.","title":"Connector Id"},"description":"Restrict results to deliveries triggered for this connector."},{"name":"webhook_action","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated webhook event types to filter logs by.","examples":["connector_synced,employee_data_changed"],"title":"Webhook Action"},"description":"Comma-separated webhook event types to filter logs by."},{"name":"response_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated HTTP response codes to filter logs by.","examples":["200,403,503"],"title":"Response Code"},"description":"Comma-separated HTTP response codes to filter logs by."},{"name":"created_at_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only logs created at or after this datetime. Format: ISO 8601. If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Created At From"},"description":"Only logs created at or after this datetime. Format: ISO 8601. If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"created_at_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only logs created at or before this datetime. Format: ISO 8601. If no timezone offset is supplied, the value is interpreted as UTC.","examples":["2024-02-21T21:22:12.993Z"],"title":"Created At To"},"description":"Only logs created at or before this datetime. Format: ISO 8601. If no timezone offset is supplied, the value is interpreted as UTC."},{"name":"errors_only","in":"query","required":false,"schema":{"type":"boolean","description":"If true, only error logs (HTTP response code >= 400) are returned.","default":false,"title":"Errors Only"},"description":"If true, only error logs (HTTP response code >= 400) are returned."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_WebhookLogEntryExternal_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/v1/webhooks/logs/{log_id}":{"get":{"tags":["Webhooks"],"summary":"Get Webhook Log Detail","description":"Get the full request/response detail for a single webhook delivery attempt.","operationId":"get_webhook_log_detail_api_v1_webhooks_logs__log_id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"log_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Log Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookLogDetailExternal"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/embedded/v1/link/create-link-token":{"post":{"tags":["Link"],"summary":"Create Link Token","operationId":"create_link_token_api_embedded_v1_link_create_link_token_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkTokenCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkTokenResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/embedded/v1/connectors/connector_token/{temporary_token}":{"get":{"tags":["Connector"],"summary":"Get Connector Token","operationId":"get_connector_token_api_embedded_v1_connectors_connector_token__temporary_token__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"temporary_token","in":"path","required":true,"schema":{"type":"string","title":"Temporary Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentConnectorResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/embedded/v1/connectors/resync":{"post":{"tags":["Connector"],"summary":"Force Resync Connector","operationId":"force_resync_connector_api_embedded_v1_connectors_resync_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"x-connector-token","in":"header","required":true,"schema":{"type":"string","title":"X-Connector-Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Force Resync Connector Api Embedded V1 Connectors Resync Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"401":{"description":"Missing or invalid bearer authentication credentials.","headers":{"WWW-Authenticate":{"description":"Bearer authentication challenge.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp (seconds since epoch) at which the current rate-limit window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying the request.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"AtsActivity":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"user":{"anyOf":[{},{"type":"null"}],"title":"User","description":"The user who owns the activity.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"activity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["NOTE","EMAIL","OTHER"],"title":"Activity Type","description":"The type of activity. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["NOTE"]},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject","description":"The subject of the activity.","examples":["Interview with John Doe"]},"body":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body","description":"The body of the activity. This can include notes, comments, or other relevant information.","examples":["John Doe was interviewed for the position of Software Engineer."]},"visibility":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["ADMIN_ONLY","PUBLIC","PRIVATE"],"title":"Visibility","description":"Visibility of the activity. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["PUBLIC"]},"candidate":{"anyOf":[{},{"type":"null"}],"title":"Candidate","description":"Candidate who applied for the activity.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"remote_created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Created At","description":"When the third party's candidate was created.","examples":["2021-07-01T00:00:00Z"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","user","activity_type","subject","body","visibility","candidate","remote_created_at"],"title":"AtsActivity","description":"The activity object is used to represent any activity in the ATS."},"AtsApplication":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"candidate":{"anyOf":[{},{"type":"null"}],"title":"Candidate","description":"The candidate associated with the application.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"job":{"anyOf":[{},{"type":"null"}],"title":"Job","description":"The job for which the candidate has applied.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"applied_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Applied At","description":"The date and time when the candidate applied for the job.","examples":["2021-01-01T00:00:00Z"]},"rejected_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rejected At","description":"The date and time when the application was rejected.","examples":["2021-01-01T00:00:00Z"]},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","description":"The source from where the candidate's application originated.","examples":["LinkedIn"]},"credited_to":{"anyOf":[{},{"type":"null"}],"title":"Credited To","description":"The user or entity to which the application is credited.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"current_stage":{"anyOf":[{},{"type":"null"}],"title":"Current Stage","description":"The current stage of the application in the hiring process.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"reject_reason":{"anyOf":[{},{"type":"null"}],"title":"Reject Reason","description":"The reason for the application's rejection.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","candidate","job","applied_at","rejected_at","source","credited_to","current_stage","reject_reason"],"title":"AtsApplication","description":"The AtsApplication object is used to represent an application within the ATS."},"AtsAttachment":{"properties":{"file_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Name","description":"The name of the file attached.","examples":["resume.pdf"]},"file_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"File Url","description":"The URL where the file is stored and can be retrieved.","examples":["https://example.com/path/to/resume.pdf"]},"attachment_type":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["RESUME","COVER_LETTER","OFFER_LETTER","OTHER","-"],"title":"Attachment Type","description":"The type of attachment. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["RESUME"]},"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"candidate":{"anyOf":[{},{"type":"null"}],"title":"Candidate","description":"The candidate to whom the attachment belongs.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields"],"title":"AtsAttachment"},"AtsAttachmentWrite":{"properties":{"file_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Name","description":"The name of the file attached.","examples":["resume.pdf"]},"file_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"File Url","description":"The URL where the file is stored and can be retrieved.","examples":["https://example.com/path/to/resume.pdf"]},"attachment_type":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["RESUME","COVER_LETTER","OFFER_LETTER","OTHER","-"],"title":"Attachment Type","description":"The type of attachment. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["RESUME"]},"file_content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Content","description":"File in base64 format","examples":["SGVsbG8sIFdvcmxkIQ=="]},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type","description":"The MIME type of the file (e.g., 'application/pdf', 'image/png').","examples":["application/pdf"]},"candidate":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Candidate","description":"The candidate to whom the attachment belongs.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"remote_user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Remote User Id","description":"The id of user using the integration","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]}},"type":"object","title":"AtsAttachmentWrite","description":"The AtsAttachmentWriteForCandidate object is used to represent a file attachment linked to a candidate's application within the ATS."},"AtsCandidate":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"The candidate's first name.","examples":["John"]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"The candidate's last name.","examples":["Doe"]},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company","description":"The name of the company where candidate has applied.","examples":["Google"]},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The position for which the candidate has applied","examples":["SOFTWARE ENGINEER"]},"last_interaction_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Interaction At","description":"The date of the last interaction with the candidate.","examples":["2021-07-01T00:00:00Z"]},"is_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Private","description":"Whether the candidate's information is private.","examples":[true]},"can_email":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Can Email","description":"Whether the candidate can be emailed.","examples":[true]},"locations":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Locations","description":"The location of the candidate.","examples":["San Francisco","New York"]},"phone_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Phone Numbers","description":"The candidate's phone numbers.","examples":["123-456-7890"]},"email_addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Email Addresses","description":"The candidate's email addresses.","examples":["john@doe.com"]},"urls":{"anyOf":[{"items":{"$ref":"#/components/schemas/AtsUrl"},"type":"array"},{"type":"null"}],"title":"Urls","description":"The candidate's URLs. This can include a personal website, LinkedIn profile, or other relevant URLs.","examples":[{"type":"LINKEDIN","value":"https://www.linkedin.com/in/johndoe"}]},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","description":"The candidate's tags. Tags are used to categorize candidates and can be used to filter candidates in the UI.","examples":["JUNIOR","INTERMEDIATE"]},"applications":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Applications","description":"The candidate's applications.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"attachments":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Attachments","description":"The candidate's attachments.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"remote_created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Created At","description":"When the third party's candidate was created.","examples":["2021-07-01T00:00:00Z"]},"remote_updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Updated At","description":"When the third party's candidate was last updated.","examples":["2021-07-01T00:00:00Z"]},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatar","description":"The candidate's avatar.","examples":["https://www.example.com/avatar.jpg"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields"],"title":"AtsCandidate"},"AtsCandidateWrite":{"properties":{"additional_attributes":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Additional Attributes","description":"Specific fields required by the chosen HRIS","examples":[{"contract_end_date":"2025-12-31T00:00:00","previous_employer":"TechCorp"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"customTshirtSize":"XXL"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"The candidate's first name.","examples":["John"]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"The candidate's last name.","examples":["Doe"]},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company","description":"The name of the company where candidate has applied.","examples":["Google"]},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The position for which the candidate has applied","examples":["SOFTWARE ENGINEER"]},"last_interaction_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Interaction At","description":"The date of the last interaction with the candidate.","examples":["2021-07-01T00:00:00Z"]},"is_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Private","description":"Whether the candidate's information is private.","examples":[true]},"can_email":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Can Email","description":"Whether the candidate can be emailed.","examples":[true]},"locations":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Locations","description":"The location of the candidate.","examples":["San Francisco","New York"]},"phone_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Phone Numbers","description":"The candidate's phone numbers.","examples":["123-456-7890"]},"email_addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Email Addresses","description":"The candidate's email addresses.","examples":["john@doe.com"]},"urls":{"anyOf":[{"items":{"$ref":"#/components/schemas/AtsUrl"},"type":"array"},{"type":"null"}],"title":"Urls","description":"The candidate's URLs. This can include a personal website, LinkedIn profile, or other relevant URLs.","examples":[{"type":"LINKEDIN","value":"https://www.linkedin.com/in/johndoe"}]},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","description":"The candidate's tags. Tags are used to categorize candidates and can be used to filter candidates in the UI.","examples":["JUNIOR","INTERMEDIATE"]},"applications":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Applications","description":"The candidate's applications.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/AtsAttachmentWrite"},"type":"array"},{"type":"null"}],"title":"Attachments","description":"Please share the details like this, AtsAttachmentWrite model fields are shared in model_fields key","examples":[{"attachment_type":"RESUME","file_name":"resume.pdf","file_url":"https://example.com/resume.pdf"}]},"remote_created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Created At","description":"When the third party's candidate was created.","examples":["2021-07-01T00:00:00Z"]},"remote_updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Updated At","description":"When the third party's candidate was last updated.","examples":["2021-07-01T00:00:00Z"]},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatar","description":"The candidate's avatar.","examples":["https://www.example.com/avatar.jpg"]},"job":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Job","description":"The job id for the candidate","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]}},"type":"object","title":"AtsCandidateWrite"},"AtsDepartment":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the department.","examples":["Engineering"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","name"],"title":"AtsDepartment","description":"The AtsDepartment object represents a department within the company in the ATS."},"AtsEEOC":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"candidate":{"anyOf":[{},{"type":"null"}],"title":"Candidate","description":"The candidate associated with the EEOC data.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"submitted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submitted At","description":"The ISO date string when the EEOC data was submitted.","examples":["2021-01-01T00:00:00Z"]},"race":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["AMERICAN_INDIAN_OR_ALASKA_NATIVE","ASIAN_OR_INDIAN_SUBCONTINENT","BLACK_OR_AFRICAN_AMERICAN","HISPANIC_OR_LATINO","NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER","TWO_OR_MORE_RACES","WHITE","PREFER_NOT_TO_DISCLOSE","-"],"title":"Race","description":"The race of the candidate as indicated in the EEOC form. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["WHITE"]},"gender":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["MALE","FEMALE","NON-BINARY","OTHER","PREFER_NOT_TO_DISCLOSE","-"],"title":"Gender","description":"The gender of the candidate as indicated in the EEOC form. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["MALE"]},"veteran_status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["I_DONT_WISH_TO_ANSWER","DISABLED_VETERAN","SPECIAL_DISABLED_VETERAN","VIETNAM_ERA_VETERAN","OTHER_PROTECTED_VETERAN","THREE_YEAR_RECENTLY_SEPARATED_VETERAN","ONE_YEAR_RECENTLY_SEPARATED_VETERAN","DISABLED_INDIVIDUAL","I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN","I_AM_NOT_A_PROTECTED_VETERAN","-"],"title":"Veteran Status","description":"The veteran status of the candidate as indicated in the EEOC form. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["DISABLED_VETERAN"]},"disability_status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY","NO_I_DONT_HAVE_A_DISABILITY","I_DONT_WISH_TO_ANSWER","-"],"title":"Disability Status","description":"The disability status of the candidate as indicated in the EEOC form. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","candidate","submitted_at","race","gender","veteran_status","disability_status"],"title":"AtsEEOC","description":"The AtsEEOC object represents the Equal Employment Opportunity Commission (EEOC) related data for a candidate within the ATS."},"AtsJob":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the job.","examples":["SOFTWARE ENGINEER"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A detailed description of the job.","examples":["We are looking for a software engineer to join our team."]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"The internal or external code that identifies the job.","examples":["SE-2021-01"]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["OPEN","CLOSED","DRAFT","ARCHIVED","PENDING","-"],"title":"Status","description":"The current status of the job posting. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["OPEN"]},"job_posting_urls":{"anyOf":[{"items":{"$ref":"#/components/schemas/AtsUrl"},"type":"array"},{"type":"null"}],"title":"Job Posting Urls","description":"A list of URLs where the job is posted.","examples":["https://www.company.com/careers/software-engineer"]},"remote_created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Created At","description":"The ISO date string when the job was first created in the ATS.","examples":["2021-01-01T00:00:00Z"]},"remote_updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Updated At","description":"The ISO date string when the job was last updated in the ATS.","examples":["2021-01-01T00:00:00Z"]},"confidential":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Confidential","description":"Whether the job posting is confidential.","examples":[false]},"departments":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Departments","description":"A list of department identifiers associated with the job.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65","018b4bfb-5ece-70b1-ad5e-862a9433aa23"]},"offices":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Offices","description":"A list of office identifiers where the job is located.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65","018b4bfb-5ece-70b1-ad5e-862a9433aa23"]},"hiring_managers":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Hiring Managers","description":"A list of identifiers for hiring managers associated with the job.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65","018b4bfb-5ece-70b1-ad5e-862a9433aa23"]},"recruiters":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Recruiters","description":"A list of identifiers for recruiters associated with the job.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","name","description","code","status","job_posting_urls","remote_created_at","remote_updated_at","confidential","departments","offices","hiring_managers","recruiters"],"title":"AtsJob","description":"The AtsJob object represents a job posting within the ATS."},"AtsJobInterviewStage":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the interview stage.","examples":["PHONE SCREENING"]},"job":{"anyOf":[{},{"type":"null"}],"title":"Job","description":"The identifier of the job to which this interview stage is related.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"stage_order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Stage Order","description":"The order or sequence number of the stage within the interview process.","examples":[3]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","name","job","stage_order"],"title":"AtsJobInterviewStage","description":"The AtsJobInterviewStage object represents a stage in the interview process for a job within the ATS."},"AtsOffer":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"application":{"anyOf":[{},{"type":"null"}],"title":"Application","description":"The identifier of the application to which the offer is related.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"creator":{"anyOf":[{},{"type":"null"}],"title":"Creator","description":"The identifier of the user who created the offer.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"remote_created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Created At","description":"The ISO date string when the offer was created in the third-party system.","examples":["2021-01-01T00:00:00Z"]},"closed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Closed At","description":"The ISO date string when the offer was closed.","examples":["2021-01-01T00:00:00Z"]},"sent_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sent At","description":"The ISO date string when the offer was sent to the candidate.","examples":["2021-01-01T00:00:00Z"]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date","description":"The proposed start date for the candidate, as an ISO date string.","examples":["2021-01-01T00:00:00Z"]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["DRAFT","APPROVAL-SENT","APPROVED","SENT","SENT-MANUALLY","OPENED","DENIED","SIGNED","DEPRECATED"],"title":"Status","description":"The current status of the offer. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["APPROVED"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","application","creator","remote_created_at","closed_at","sent_at","start_date","status"],"title":"AtsOffer","description":"The AtsOffer object represents a job offer associated with an application within the ATS."},"AtsOffice":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the office.","examples":["San Francisco"]},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location","description":"The physical location or address of the office.","examples":["1234 Main Street, San Francisco, CA 94111"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","name","location"],"title":"AtsOffice","description":"The AtsOffice object represents an office or physical location of the company in the ATS."},"AtsRejectReason":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name or title of the reject reason.","examples":["Not a good fit"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","name"],"title":"AtsRejectReason","description":"The AtsRejectReason object represents a reason for rejecting a candidate within the ATS."},"AtsRemoteUser":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"The first name of the user.","examples":["John"]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"The last name of the user.","examples":["Doe"]},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"The email address of the user.","examples":["john@doe.com"]},"disabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Disabled","description":"Indicates whether the user's account is disabled.","examples":[false]},"remote_created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Created At","description":"The ISO date string when the user profile was created in the remote system.","examples":["2021-01-01T00:00:00Z"]},"access_role":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["ADMIN","SUPER_ADMIN","TEAM_MEMBER","LIMITED_TEAM_MEMBER","INTERVIEWER","RECRUITER","-"],"title":"Access Role","description":"The role of the user defining their level of access. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["ADMIN"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","first_name","last_name","email","disabled","remote_created_at","access_role"],"title":"AtsRemoteUser","description":"The AtsRemoteUser object represents a user profile from a remote system that interacts with the ATS."},"AtsScheduledInterview":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"application":{"anyOf":[{},{"type":"null"}],"title":"Application","description":"The identifier of the application associated with the interview.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"job_interview_stage":{"anyOf":[{},{"type":"null"}],"title":"Job Interview Stage","description":"The identifier of the interview stage associated with this interview.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"organizer":{"anyOf":[{},{"type":"null"}],"title":"Organizer","description":"The identifier of the user who organized the interview.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"interviewers":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Interviewers","description":"A list of identifiers for the users who are scheduled to interview the candidate.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65","018b4bfb-5ece-70b1-ad5e-862a9412aa12"]},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location","description":"The location where the interview is scheduled to take place.","examples":["123 Main St, Anytown, USA"]},"start_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start At","description":"The ISO date string when the interview is scheduled to start.","examples":["2021-01-01T00:00:00Z"]},"end_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End At","description":"The ISO date string when the interview is scheduled to end.","examples":["2021-01-01T00:00:00Z"]},"remote_created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Created At","description":"The ISO date string when the interview was created in the remote system.","examples":["2021-01-01T00:00:00Z"]},"remote_updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Updated At","description":"The ISO date string when the interview was last updated in the remote system.","examples":["2021-01-01T00:00:00Z"]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["SCHEDULED","AWAITING_FEEDBACK","COMPLETE"],"title":"Status","description":"The current status of the scheduled interview. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["SCHEDULED"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","application","job_interview_stage","organizer","interviewers","location","start_at","end_at","remote_created_at","remote_updated_at","status"],"title":"AtsScheduledInterview","description":"The AtsScheduledInterview object represents an interview event scheduled within the ATS."},"AtsScorecard":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"application":{"anyOf":[{},{"type":"null"}],"title":"Application","description":"The identifier of the application associated with the scorecard.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"interview":{"anyOf":[{},{"type":"null"}],"title":"Interview","description":"The identifier of the interview associated with the scorecard.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"interviewer":{"anyOf":[{},{"type":"null"}],"title":"Interviewer","description":"The identifier of the interviewer who filled out the scorecard.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"remote_created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Created At","description":"The ISO date string when the scorecard was created in the remote system.","examples":["2021-01-01T00:00:00Z"]},"submitted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submitted At","description":"The ISO date string when the scorecard was submitted by the interviewer.","examples":["2021-01-01T00:00:00Z"]},"overall_recommendation":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["DEFINITELY_NO","NO","NO_DECISION","YES","STRONG_YES"],"title":"Overall Recommendation","description":"The final recommendation or decision submitted by the interviewer. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["YES"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","application","interview","interviewer","remote_created_at","submitted_at","overall_recommendation"],"title":"AtsScorecard","description":"The AtsScorecard object represents an evaluation of a candidate's interview within the ATS."},"AtsScreeningQuestion":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"job":{"anyOf":[{},{"type":"null"}],"title":"Job","description":"The identifier of the job to which this screening question is related.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A detailed description of the screening question.","examples":["Please describe your experience with Python."]},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The title of the screening question.","examples":["Python Experience"]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["DATE","FILE","SINGLE_SELECT","MULTI_SELECT","SINGLE_LINE_TEXT","MULTI_LINE_TEXT","NUMERIC","BOOLEAN"],"title":"Type","description":"The type of screening question. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["SINGLE_LINE_TEXT"]},"required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Required","description":"Indicates whether answering the question is required for the applicant.","examples":[true]},"options":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Options","description":"The possible options for answering the question, if applicable.","examples":["Yes","No","N/A"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","job","description","title","type","required","options"],"title":"AtsScreeningQuestion","description":"The AtsScreeningQuestion object represents a question used to screen candidates for a job within the ATS."},"AtsTag":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the tag.","examples":["JUNIOR"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","name"],"title":"AtsTag","description":"The AtsTag object represents a tag that can be applied to candidates, jobs, or other entities within the ATS."},"AtsUrl":{"properties":{"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value","description":"The site's url."},"url_type":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["PERSONAL","COMPANY","PORTFOLIO","BLOG","SOCIAL_MEDIA","OTHER","JOB_POSTING","-"],"title":"Url Type","description":"The type of site. If the value is not one of the defined enum values, the original value passed through will be returned."}},"type":"object","required":["value","url_type"],"title":"AtsUrl"},"Category":{"type":"string","enum":["HRIS","ATS","LMS"],"title":"Category"},"ConnectorResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Id of the connector","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"is_active":{"type":"boolean","title":"Is Active","description":"Flag to indicate if connector is active or not","examples":[true]},"status":{"$ref":"#/components/schemas/ConnectorStatus","description":"Link status of the connector","examples":["COMPLETE"]},"integration_slug":{"type":"string","title":"Integration Slug","description":"Integration slug for the particular connector","examples":["ukg-pro"]},"end_user":{"type":"string","title":"End User","description":"Name of the end user which is used when creating corresponding connector","examples":["Acme Corp."]},"origin_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin Id","description":"Origin ID of the end user","examples":["user_123"]},"sync_status":{"anyOf":[{"$ref":"#/components/schemas/JobDisplayStatus"},{"type":"null"}],"description":"Latest Sync status of the connector","examples":["Done"]},"last_sync_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Sync Start Time","description":"This time represent last sync start time","examples":["2024-10-16T00:00:00Z"]},"next_sync_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Sync Start Time","description":"This time represent next sync start time","examples":["2024-10-17T00:00:00Z"]},"connector_token":{"type":"string","title":"Connector Token","description":"Connector token for this connector","examples":["LJITuCJFqpGXeKfZtn4I9ZcahzA-lkCSO6uhDKj5xw9EzPL96qk7ObgIHQQ1GnxH"]},"category":{"$ref":"#/components/schemas/Category","description":"Category of the connector","examples":["HRIS"]},"relink_needed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Relink Needed At","description":"Time at which credentials were deemed invalid","examples":["2024-10-17T00:00:00Z"]},"is_test_connector":{"type":"boolean","title":"Is Test Connector","description":"Flag indicating if connector is test connector or not","examples":[false]},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At","description":"Indicated time at which connector has been linked properly","examples":["2024-10-17T00:00:00Z"]},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Connector creation time","examples":["2024-10-17T00:00:00Z"]}},"type":"object","required":["id","is_active","status","integration_slug","end_user","origin_id","sync_status","last_sync_start_time","next_sync_start_time","connector_token","category","relink_needed_at","is_test_connector","completed_at","created_at"],"title":"ConnectorResponse"},"ConnectorStatus":{"type":"string","enum":["COMPLETE","INCOMPLETE","RELINK_NEEDED"],"title":"ConnectorStatus"},"CreateAtsActivity":{"properties":{"user":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"User","description":"The user who owns the activity.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"activity_type":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["NOTE","EMAIL","OTHER"],"title":"Activity Type","description":"The type of activity. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["NOTE"]},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject","description":"The subject of the activity.","examples":["Interview with John Doe"]},"body":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body","description":"The body of the activity. This can include notes, comments, or other relevant information.","examples":["John Doe was interviewed for the position of Software Engineer."]},"visibility":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["ADMIN_ONLY","PUBLIC","PRIVATE"],"title":"Visibility","description":"Visibility of the activity. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["PUBLIC"]},"candidate":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Candidate","description":"Candidate who applied for the activity.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]}},"type":"object","required":["user","activity_type","body","visibility","candidate"],"title":"CreateAtsActivity"},"CreateAtsJob":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the job.","examples":["SOFTWARE ENGINEER"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A detailed description of the job.","examples":["We are looking for a software engineer to join our team."]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"The internal or external code that identifies the job.","examples":["SE-2021-01"]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["OPEN","CLOSED","DRAFT","ARCHIVED","PENDING","-"],"title":"Status","description":"The current status of the job posting. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["OPEN"]},"job_posting_urls":{"anyOf":[{"items":{"$ref":"#/components/schemas/AtsUrl"},"type":"array"},{"type":"null"}],"title":"Job Posting Urls","description":"A list of URLs where the job is posted.","examples":["https://www.company.com/careers/software-engineer"]},"confidential":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Confidential","description":"Whether the job posting is confidential.","examples":[false]},"departments":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Departments","description":"A list of department identifiers associated with the job.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65","018b4bfb-5ece-70b1-ad5e-862a9433aa23"]},"offices":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Offices","description":"A list of office identifiers where the job is located.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65","018b4bfb-5ece-70b1-ad5e-862a9433aa23"]},"hiring_managers":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Hiring Managers","description":"A list of identifiers for hiring managers associated with the job.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65","018b4bfb-5ece-70b1-ad5e-862a9433aa23"]},"recruiters":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Recruiters","description":"A list of identifiers for recruiters associated with the job.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Id","description":"The template id associated with the job.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"remote_user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Remote User Id","description":"The remote user's id who is creating the job.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"openings":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Openings","description":"Number of openings for the job.","examples":[3]}},"type":"object","title":"CreateAtsJob"},"CreateCandidate":{"properties":{"data":{"$ref":"#/components/schemas/PostCandidate"},"remote_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote User Id","description":"The remote user's id","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"job_requisition_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Requisition Id","description":"The job requisition id in external ATS","examples":["R-00007"]}},"type":"object","required":["data"],"title":"CreateCandidate"},"CurrentConnectorResponseModel":{"properties":{"connector_token":{"type":"string","title":"Connector Token","description":"Connector token of the connector using which you can make API calls to Bindbee","examples":["jk23h4jk23hk4j2h3kj4h23kjh4k23jh4k2j3h4"]},"connector_id":{"type":"string","format":"uuid","title":"Connector Id","description":"The ID of the connector associated with the request","examples":["123e4567-e89b-12d3-a456-426614174000"]}},"type":"object","required":["connector_token","connector_id"],"title":"CurrentConnectorResponseModel"},"CustomFieldCreateExternal":{"properties":{"name":{"type":"string","maxLength":128,"minLength":2,"title":"Name","description":"Name of the custom field. Must be snake_case.","examples":["guardian_mobile"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the custom field.","examples":["Employee's guardian mobile number"]},"category":{"$ref":"#/components/schemas/Category","description":"Category of the model on which the custom field is created.","examples":["HRIS"]},"model":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9_-]*$","title":"Model","description":"Model on which the custom field is to be applied.","examples":["employee"]}},"type":"object","required":["name","category","model"],"title":"CustomFieldCreateExternal"},"CustomFieldDetailExternal":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the custom field.","examples":["018e586b-7d0b-7bc9-be65-a8fdbc82d734"]},"name":{"type":"string","title":"Name","description":"Name of the custom field (snake_case).","examples":["guardian_mobile"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the custom field.","examples":["Employee's guardian mobile number"]},"category":{"$ref":"#/components/schemas/Category","description":"Category of the model.","examples":["HRIS"]},"model":{"type":"string","title":"Model","description":"Model on which the custom field is applied.","examples":["employee"]},"source":{"$ref":"#/components/schemas/CustomFieldSource","description":"Origin of the custom field. 'API' if created through the public API, 'DASHBOARD' if created from the Bindbee dashboard.","examples":["API"]},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"mappings":{"items":{"$ref":"#/components/schemas/CustomFieldMappingExternal"},"type":"array","title":"Mappings","description":"All mappings configured for this custom field."},"mapping_counts":{"$ref":"#/components/schemas/CustomFieldMappingCounts","description":"Counts of mappings for this custom field, broken down by scope."}},"type":"object","required":["id","name","category","model","source","created_at","mapping_counts"],"title":"CustomFieldDetailExternal"},"CustomFieldExternal":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the custom field.","examples":["018e586b-7d0b-7bc9-be65-a8fdbc82d734"]},"name":{"type":"string","title":"Name","description":"Name of the custom field (snake_case).","examples":["guardian_mobile"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the custom field.","examples":["Employee's guardian mobile number"]},"category":{"$ref":"#/components/schemas/Category","description":"Category of the model.","examples":["HRIS"]},"model":{"type":"string","title":"Model","description":"Model on which the custom field is applied.","examples":["employee"]},"source":{"$ref":"#/components/schemas/CustomFieldSource","description":"Origin of the custom field. 'API' if created through the public API, 'DASHBOARD' if created from the Bindbee dashboard.","examples":["API"]},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["id","name","category","model","source","created_at"],"title":"CustomFieldExternal"},"CustomFieldMappingCounts":{"properties":{"total":{"type":"integer","title":"Total","description":"Total number of mappings configured for this custom field.","examples":[3]},"organization":{"type":"integer","title":"Organization","description":"Number of organization-scoped (integration-level) mappings.","examples":[1]},"connector":{"type":"integer","title":"Connector","description":"Number of connector-scoped mappings.","examples":[2]}},"type":"object","required":["total","organization","connector"],"title":"CustomFieldMappingCounts"},"CustomFieldMappingCreateExternal":{"properties":{"custom_field_id":{"type":"string","format":"uuid","title":"Custom Field Id","description":"ID of the custom field to be mapped.","examples":["018e586b-7d0b-7bc9-be65-a8fdbc82d734"]},"integration_slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Slug","description":"Integration slug — set this for an organization-scoped mapping (applies to all connectors of this integration in the org). Mutually exclusive with `connector_token`.","examples":["workday"]},"connector_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connector Token","description":"Connector token — set this for a connector-scoped mapping (applies to a single connector instance). Mutually exclusive with `integration_slug`.","examples":["i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"]},"json_path":{"type":"string","maxLength":1024,"pattern":"\\S.*\\S","title":"Json Path","description":"JMESPath expression to extract the value from the upstream payload."}},"type":"object","required":["custom_field_id","json_path"],"title":"CustomFieldMappingCreateExternal"},"CustomFieldMappingExternal":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the mapping.","examples":["018e586b-7d0b-7bc9-be65-a8fdbc82d734"]},"custom_field_id":{"type":"string","format":"uuid","title":"Custom Field Id","description":"ID of the custom field this mapping belongs to.","examples":["018e586b-7d0b-7bc9-be65-a8fdbc82d734"]},"integration_slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Slug","description":"Integration slug. Set when the mapping is organization-scoped; null otherwise.","examples":["workday"]},"connector_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connector Token","description":"Connector token. Set when the mapping is connector-scoped; null otherwise.","examples":["i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"]},"json_path":{"type":"string","title":"Json Path","description":"JMESPath expression used to extract the value from the upstream payload.","examples":["data.employee.guardian_mobile"]},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["id","custom_field_id","json_path","created_at"],"title":"CustomFieldMappingExternal"},"CustomFieldMappingUpdateExternal":{"properties":{"json_path":{"type":"string","maxLength":1024,"pattern":"\\S.*\\S","title":"Json Path","description":"JMESPath expression to extract the value from the upstream payload."}},"type":"object","required":["json_path"],"title":"CustomFieldMappingUpdateExternal"},"CustomFieldPreviewRequest":{"properties":{"connector_token":{"type":"string","title":"Connector Token","description":"Connector token to evaluate the JMESPath against.","examples":["i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"]},"category":{"$ref":"#/components/schemas/Category","description":"Category of the model.","examples":["HRIS"]},"model":{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9_-]*$","title":"Model","description":"Model slug whose raw payload will be evaluated.","examples":["employee"]},"json_path":{"type":"string","maxLength":1024,"pattern":"\\S.*\\S","title":"Json Path","description":"JMESPath expression to evaluate.","examples":["data.employee.guardian_mobile"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"Optional inline payload to evaluate against. If omitted, the connector's latest synced row is used (falling back to the integration sample if never synced).","examples":[null]}},"type":"object","required":["connector_token","category","model","json_path"],"title":"CustomFieldPreviewRequest"},"CustomFieldPreviewResponse":{"properties":{"connector_token":{"type":"string","title":"Connector Token","description":"Connector the JMESPath was evaluated against.","examples":["i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T"]},"json_path":{"type":"string","title":"Json Path","description":"JMESPath expression that was evaluated.","examples":["data.employee.guardian_mobile"]},"resolved_value":{"anyOf":[{},{"type":"null"}],"title":"Resolved Value","description":"The value the JMESPath resolved to. May be of any JSON type or null.","examples":["+1-555-123-4567"]},"resolved_value_type":{"type":"string","title":"Resolved Value Type","description":"JSON type of the resolved value: 'string', 'number', 'boolean', 'object', 'array', or 'null'.","examples":["string"]},"raw_data_source":{"type":"string","title":"Raw Data Source","description":"Where the evaluated payload came from: 'connector_sync' (latest synced row), 'integration_sample' (fallback when never synced), or 'inline' (provided in the request body).","examples":["connector_sync"]}},"type":"object","required":["connector_token","json_path","resolved_value_type","raw_data_source"],"title":"CustomFieldPreviewResponse"},"CustomFieldSource":{"type":"string","enum":["DASHBOARD","API"],"title":"CustomFieldSource"},"CustomFieldUpdateExternal":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":128,"minLength":2},{"type":"null"}],"title":"Name","description":"Name of the custom field. Must be snake_case.","examples":["guardian_mobile"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the custom field. Send null to clear it.","examples":["Employee's guardian mobile number"]},"category":{"anyOf":[{"$ref":"#/components/schemas/Category"},{"type":"null"}],"description":"Category of the model on which the custom field is created. Cannot be changed once the field has mappings.","examples":["HRIS"]},"model":{"anyOf":[{"type":"string","maxLength":64,"pattern":"^[a-z][a-z0-9_-]*$"},{"type":"null"}],"title":"Model","description":"Model on which the custom field is to be applied. Cannot be changed once the field has mappings.","examples":["employee"]}},"type":"object","title":"CustomFieldUpdateExternal"},"Deduction":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The deduction's name.","examples":["Social Security"]},"employee_deduction":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Employee Deduction","description":"The amount of money that is withheld from an employee's gross pay by the employee.","examples":[27.22]},"company_deduction":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Company Deduction","description":"The amount of money that is withheld on behalf of an employee by the company.","examples":[77.57]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"The currency of the deduction amount.","examples":["USD"]},"payroll_code":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Payroll Code","description":"The ID of the payroll code associated with this deduction.","examples":["019fbd01-e394-76ed-93fb-b9eda49a3b41"]}},"type":"object","required":["name","employee_deduction","company_deduction"],"title":"Deduction"},"Earning":{"properties":{"amount":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Amount","description":"The amount earned.","examples":["27151"]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["SALARY","REIMBURSEMENT","OVERTIME","BONUS","HOURLY"],"title":"Name","description":"The type of earning. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["SALARY"]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"The currency of the earning amount.","examples":["USD"]},"payroll_code":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Payroll Code","description":"The ID of the payroll code associated with this earning.","examples":["019fbd01-e900-7418-a54c-3fcba1299e88"]}},"type":"object","required":["amount","name"],"title":"Earning"},"EffectiveCustomFieldEntry":{"properties":{"custom_field_id":{"type":"string","format":"uuid","title":"Custom Field Id","description":"ID of the custom field.","examples":["018e586b-7d0b-7bc9-be65-a8fdbc82d734"]},"name":{"type":"string","title":"Name","description":"Name of the custom field.","examples":["guardian_mobile"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of the custom field."},"category":{"$ref":"#/components/schemas/Category","description":"Category of the model.","examples":["HRIS"]},"model":{"type":"string","title":"Model","description":"Model the custom field is applied to.","examples":["employee"]},"json_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Json Path","description":"The effective JMESPath in use for this field on this connector. Null when no mapping exists.","examples":["data.employee.guardian_mobile"]},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","description":"Which mapping is in effect: 'connector' (connector-scoped override), 'organization' (org-scoped inherited), or null (no mapping configured).","examples":["connector"]},"mapping_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Mapping Id","description":"ID of the underlying mapping row, for editing. Null when unmapped.","examples":["018e586b-7d0b-7bc9-be65-a8fdbc82d734"]}},"type":"object","required":["custom_field_id","name","category","model"],"title":"EffectiveCustomFieldEntry"},"EffectiveCustomFieldResponse":{"properties":{"connector_token":{"type":"string","title":"Connector Token","description":"Connector the effective view was computed for."},"integration_slug":{"type":"string","title":"Integration Slug","description":"Slug of the integration this connector belongs to.","examples":["workday"]},"category":{"$ref":"#/components/schemas/Category","description":"Category filter applied.","examples":["HRIS"]},"model":{"type":"string","title":"Model","description":"Model filter applied.","examples":["employee"]},"fields":{"items":{"$ref":"#/components/schemas/EffectiveCustomFieldEntry"},"type":"array","title":"Fields","description":"Every custom field for this org matching (category, model), with the effective mapping per field. Includes unmapped fields so callers can see what is left to configure."}},"type":"object","required":["connector_token","integration_slug","category","model","fields"],"title":"EffectiveCustomFieldResponse"},"EndUserCreate":{"properties":{"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email","description":"Email of the end_user","examples":["my_email@gmail.com"]},"org_name":{"type":"string","minLength":2,"title":"Organization Name","description":"Name of the organization to which end user belongs","examples":["Kunal Organization"]},"origin_id":{"type":"string","minLength":2,"title":"Unique Identifier","description":"Unique identifier to identify Connector","examples":["2kh3ub45"]}},"type":"object","required":["org_name","origin_id"],"title":"EndUserCreate"},"HRISPayrollCodeSubType":{"anyOf":[{"$ref":"#/components/schemas/HRISPayrollEarningSubType"},{"$ref":"#/components/schemas/HRISPayrollDeductionSubType"},{"$ref":"#/components/schemas/HRISPayrollTaxSubType"}]},"HRISPayrollCodeType":{"type":"string","enum":["EARNING","DEDUCTION","TAX"],"title":"HRISPayrollCodeType"},"HRISPayrollDeductionSubType":{"type":"string","enum":["HEALTH","DENTAL","VISION","HEALTH_SAVINGS","FLEXIBLE_SPENDING","RETIREMENT","LIFE_INSURANCE","SUPPLEMENTAL_INSURANCE","DISABILITY","GARNISHMENT"],"title":"HRISPayrollDeductionSubType"},"HRISPayrollEarningSubType":{"type":"string","enum":["REGULAR","OVERTIME","BONUS","ALLOWANCE","TIME_OFF","SEVERANCE","EQUITY","REIMBURSEMENT","RETRO"],"title":"HRISPayrollEarningSubType"},"HRISPayrollTaxSubType":{"type":"string","enum":["FUTA","SUTA","FICA","MEDICARE","FIT","SIT","INCOME_TAX","UNEMPLOYMENT","LEVY","SOCIAL_SECURITY"],"title":"HRISPayrollTaxSubType"},"HTTPMethod-Input":{"type":"string","enum":["CONNECT","DELETE","GET","HEAD","OPTIONS","PATCH","POST","PUT","TRACE"],"title":"HTTPMethod","description":"HTTP methods and descriptions\n\nMethods from the following RFCs are all observed:\n\n    * RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616\n    * RFC 5789: PATCH Method for HTTP"},"HTTPMethod-Output":{"type":"string","enum":["GET","POST","PUT","DELETE"],"title":"HTTPMethod"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HrisAddress":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the location","examples":["UK-HO-London"]},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location","description":"Location","examples":["UK-HO-London"]},"street_1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street 1","description":"Street 1","examples":["1011"]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street 2","description":"Street 2","examples":["Lane number 4, Golden Villa"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City","examples":["London"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State","examples":["LND"]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code","description":"Postal Code","examples":["56273"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country","examples":["UK"]}},"type":"object","title":"HrisAddress"},"HrisBankInfo":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"employee":{"anyOf":[{},{"type":"null"}],"title":"Employee","description":"The employee that appears in the third-party integration's UI.","examples":["018af1fe-1250-772d-87c5-6f725a579e8a"]},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number","description":"The bank account number of the employee.","examples":["123456789012"]},"routing_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Routing Number","description":"Bank identifier for financial transactions in the US for an employee.","examples":["123456789"]},"bank_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Name","description":"The employee's bank name.","examples":["Wells Fargo"]},"account_type":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["SAVINGS","CHECKING","-"],"title":"Account Type","description":"The employee's bank account type. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["SAVINGS"]},"remote_created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Created At","description":"When the bank info of third party's employee was created.","examples":["2023-03-01T00:00:00Z"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","employee","account_number","routing_number","bank_name","account_type","remote_created_at"],"title":"HrisBankInfo","description":"The Bank info object is used to represent bank info of any person who has been employed by a company."},"HrisBenefit":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"employee":{"anyOf":[{},{"type":"null"}],"title":"Employee","description":"The employee on the plan.","examples":["018b18ef-c488-7d40-9131-91bbc47c1007"]},"plan_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Name","description":"The name of the plan.","examples":["Medical PPO"]},"provider_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Name","description":"The name of the benefit provider.","examples":["Anthem"]},"benefit_plan_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benefit Plan Type","description":"The type of benefit plan","examples":["Medical"]},"frequency":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["HOURLY","WEEKLY","BIWEEKLY","QUARTERLY","SEMIANNUALLY","ANNUALLY","THIRTEEN-MONTHLY","PRO_RATA","SEMIMONTHLY","MONTHLY","FOURWEEKLY","-"],"title":"Frequency","description":"The frequency of the plan. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["SEMIMONTHLY"]},"employee_contribution":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Employee Contribution","description":"The employee's contribution.","examples":[22.27]},"company_contribution":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Company Contribution","description":"The company's contribution.","examples":[77.22]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date","description":"The day and time the benefit started.","examples":["2023-10-18T00:00:00Z"]},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date","description":"The day and time the benefit is effective from.","examples":["2023-10-18T00:00:00Z"]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date","description":"The day and time the benefit ended.","examples":["2024-10-16T00:00:00Z"]},"employer_benefit":{"anyOf":[{},{"type":"null"}],"title":"Employer Benefit","description":"The employer benefit plan the employee is enrolled in.","examples":["018b18ef-c488-7d40-9131-91bbc47c1007"]},"benefit_plan_category":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["MEDICAL","VISION","DENTAL","HEALTH_SAVINGS","FLEXIBLE_SPENDING","LIFE_INSURANCE","DISABILITY","SUPPLEMENTAL_INSURANCE","RETIREMENT","WELLNESS","OTHER"],"title":"Benefit Plan Category","description":"The category of the plan. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["MEDICAL"]},"coverage_tier":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["WAIVED","EMPLOYEE_ONLY","EMPLOYEE_SPOUSE","EMPLOYEE_CHILD","EMPLOYEE_CHILDREN","EMPLOYEE_FAMILY","EMPLOYEE_DOMESTIC_PARTNER","HSA_FAMILY","SPOUSE","EMPLOYEE_1_DEPENDENT","EMPLOYEE_1_HOUSEHOLD_MEMBER"],"title":"Coverage Tier","description":"The coverage tier for the benefit plan. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["EMPLOYEE_ONLY"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","employee","plan_name","provider_name","benefit_plan_type","frequency","employee_contribution","company_contribution","start_date","effective_date","end_date","employer_benefit","benefit_plan_category","coverage_tier"],"title":"HrisBenefit","description":"The Benefit object is used to represent a benefit that an employee has enrolled in."},"HrisBenefitCoverage":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of the coverage amount, such as USD, INR, or EUR.","examples":["USD"]},"amount":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Amount","description":"Coverage amount associated with the benefit.","examples":[50000]},"benefit":{"anyOf":[{},{"type":"null"}],"title":"Benefit","description":"The benefit enrollment this coverage is associated with.","examples":["018b18ef-c488-7d40-9131-91bbc47c1007"]},"covered_dependents":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Covered Dependents","description":"The dependents covered under the benefit.","examples":[["018abccb-c4a9-72f6-be1d-3fc7aaf2be67"]]},"is_employee_covered":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Employee Covered","description":"Indicates whether the employee is covered under the benefit.","examples":[true]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","currency","amount","benefit","covered_dependents","is_employee_covered"],"title":"HrisBenefitCoverage","description":"The Hris Benefit Coverage object is used to represent the coverage amount associated with a benefit enrollment."},"HrisCompany":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Name","description":"The company's legal name.","examples":["Integrax Pvt. Ltd."]},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name","description":"The company's display name.","examples":["Bindbee"]},"eins":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Eins","description":"The company's Employer Identification Numbers.","examples":[["12-3456789","12-3451111"]]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","legal_name","display_name","eins"],"title":"HrisCompany","description":"The Company object is used to represent a company within the HRIS / Payroll system."},"HrisCompensation":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"employee":{"anyOf":[{},{"type":"null"}],"title":"Employee","description":"The employee holding this position.","examples":["018abccc-3208-7b2d-8b86-927945f89a42"]},"pay_group":{"anyOf":[{},{"type":"null"}],"title":"Pay Group","description":"The employee's pay group.","examples":["018b802f-4856-7ea8-a83f-ac374853ab90"]},"pay_rate":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Pay Rate","description":"The position's pay rate in dollars.","examples":[77000]},"pay_period":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["HOUR","DAY","WEEK","EVERY_TWO_WEEKS","EVERY_FOUR_WEEKS","TWICE_PER_MONTH","SEMIMONTHLY","MONTH","QUARTER","EVERY_SIX_MONTHS","YEAR","-"],"title":"Pay Period","description":"The time period this pay rate encompasses. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["YEAR"]},"pay_frequency":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["HOURLY","WEEKLY","BIWEEKLY","QUARTERLY","SEMIANNUALLY","ANNUALLY","THIRTEEN-MONTHLY","PRO_RATA","SEMIMONTHLY","MONTHLY","FOURWEEKLY","-"],"title":"Pay Frequency","description":"The position's pay frequency. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["MONTHLY"]},"pay_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pay Currency","description":"The position's currency code.","examples":["USD"]},"flsa_status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["EXEMPT","SALARIED_NONEXEMPT","NONEXEMPT","OWNER","-"],"title":"Flsa Status","description":"The position's FLSA status. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["EXEMPT"]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date","description":"The position's start date.","examples":["2022-12-15T00:00:00Z"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","employee","pay_group","pay_rate","pay_period","pay_frequency","pay_currency","flsa_status","start_date"],"title":"HrisCompensation"},"HrisConnectorResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Id of the connector","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"is_active":{"type":"boolean","title":"Is Active","description":"Flag to indicate if connector is active or not","examples":[true]},"status":{"$ref":"#/components/schemas/ConnectorStatus","description":"Link status of the connector","examples":["COMPLETE"]},"integration_slug":{"type":"string","title":"Integration Slug","description":"Integration slug for the particular connector","examples":["ukg-pro"]},"end_user":{"type":"string","title":"End User","description":"Name of the end user which is used when creating corresponding connector","examples":["Acme Corp."]},"origin_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin Id","description":"Origin ID of the end user","examples":["user_123"]},"sync_status":{"anyOf":[{"$ref":"#/components/schemas/JobDisplayStatus"},{"type":"null"}],"description":"Latest Sync status of the connector","examples":["Done"]},"last_sync_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Sync Start Time","description":"This time represent last sync start time","examples":["2024-10-16T00:00:00Z"]},"next_sync_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Sync Start Time","description":"This time represent next sync start time","examples":["2024-10-17T00:00:00Z"]},"connector_token":{"type":"string","title":"Connector Token","description":"Connector token for this connector","examples":["LJITuCJFqpGXeKfZtn4I9ZcahzA-lkCSO6uhDKj5xw9EzPL96qk7ObgIHQQ1GnxH"]},"category":{"$ref":"#/components/schemas/Category","description":"Category of the connector","examples":["HRIS"]},"relink_needed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Relink Needed At","description":"Time at which credentials were deemed invalid","examples":["2024-10-17T00:00:00Z"]},"is_test_connector":{"type":"boolean","title":"Is Test Connector","description":"Flag indicating if connector is test connector or not","examples":[false]},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At","description":"Indicated time at which connector has been linked properly","examples":["2024-10-17T00:00:00Z"]},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Connector creation time","examples":["2024-10-17T00:00:00Z"]},"sync_progress":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sync Progress","description":"Progress of the currently running sync as a percentage (0-100). Null when no sync is active or when the sync is pending/failed; use `sync_status` for those states.","examples":[42]},"total_employees":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Employees","description":"Total number of employees synced for this connector. Populated after the first sync completes; null during initial sync.","examples":[128]},"active_employees":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Active Employees","description":"Number of active employees synced for this connector. Populated after the first sync completes; null during initial sync.","examples":[120]},"avg_sync_duration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avg Sync Duration","description":"Human-readable average sync duration for this connector (e.g. `15 min 30 sec`). null until the first sync completes.","examples":["15 min 30 sec"]}},"type":"object","required":["id","is_active","status","integration_slug","end_user","origin_id","sync_status","last_sync_start_time","next_sync_start_time","connector_token","category","relink_needed_at","is_test_connector","completed_at","created_at"],"title":"HrisConnectorResponse"},"HrisDependent":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"employee":{"anyOf":[{},{"type":"null"}],"title":"Employee","description":"The employee holding this position.","examples":["018abccb-c4a9-72f6-be1d-3fc7aaf2be67"]},"home_location":{"anyOf":[{"$ref":"#/components/schemas/HrisAddress"},{"type":"null"}],"description":"The employee's home address.","examples":[{"city":"London","country":"UK","location":"UK-HO-London","postal_code":"56273","state":"LND","street_1":"1011","street_2":"Lane number 4, Golden Villa"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"The dependent's first name","examples":["Aayushi"]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Middle Name","description":"The dependent's middle name","examples":["Olivia"]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"The dependent's last name","examples":["Rai"]},"relationship":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["CHILD","SPOUSE","DOMESTIC_PARTNER","SIBLING","PARENT"],"title":"Relationship","description":"The dependent's relationship with this employee. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["SPOUSE"]},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Of Birth","description":"The dependent's date of birth","examples":["1995-04-16T00:00:00Z"]},"gender":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["MALE","FEMALE","NON-BINARY","OTHER","PREFER_NOT_TO_DISCLOSE","-"],"title":"Gender","description":"The dependent's gender. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["FEMALE"]},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"The dependent's phone number","examples":["+44-208-555-2112"]},"is_student":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Student","description":"Indicates if the dependent is a student","examples":[true]},"ssn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ssn","description":"The dependent's SSN","examples":["555-22-5555"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","employee","home_location","first_name","middle_name","last_name","relationship","date_of_birth","gender","phone_number","is_student","ssn"],"title":"HrisDependent"},"HrisDependentBenefit":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"employer_benefit":{"anyOf":[{},{"type":"null"}],"title":"Employer Benefit","description":"The employer benefit plan the dependent is enrolled in.","examples":["018b18ef-c488-7d40-9131-91bbc47c1007"]},"dependent":{"anyOf":[{},{"type":"null"}],"title":"Dependent","description":"The dependent which belongs to this benefit.","examples":["018abccb-c4a9-72f6-be1d-3fc7aaf2be67"]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date","description":"The day and time the benefit started.","examples":["2023-10-18T00:00:00Z"]},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date","description":"The day and time the benefit is effective from.","examples":["2023-10-18T00:00:00Z"]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date","description":"The day and time the benefit ended.","examples":["2024-10-16T00:00:00Z"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","employer_benefit","dependent","start_date","effective_date","end_date"],"title":"HrisDependentBenefit","description":"The Hris Dependent Benefit object is used to represent a benefit that an dependent has enrolled in."},"HrisEmployeePayrollRun":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"employee":{"anyOf":[{},{"type":"null"}],"title":"Employee","description":"The employee whose payroll is being run.","examples":["018b168d-70f9-7043-a796-56d66a4f8f07"]},"payroll_run":{"anyOf":[{},{"type":"null"}],"title":"Payroll Run","description":"The payroll being run.","examples":["018b709e-b6ef-7db4-902a-a064157bdba2"]},"gross_pay":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Gross Pay","description":"The total earnings throughout a given period for an employee before any deductions are made.","examples":[772277.77]},"net_pay":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Net Pay","description":"The take-home pay throughout a given period for an employee after deductions are made.","examples":[577221.27]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date","description":"The day and time the benefit started.","examples":["2023-07-01T00:00:00Z"]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date","description":"The day and time the benefit ended.","examples":["2023-07-31T00:00:00Z"]},"check_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Check Date","description":"The day and time the payroll run was checked.","examples":["2023-08-31T00:00:00Z"]},"earnings":{"anyOf":[{"items":{"$ref":"#/components/schemas/Earning"},"type":"array"},{"type":"null"}],"title":"Earnings","description":"The earnings of the Employee","examples":[{"amount":"27151","name":"SALARY"}]},"deductions":{"anyOf":[{"items":{"$ref":"#/components/schemas/Deduction"},"type":"array"},{"type":"null"}],"title":"Deductions","description":"The deductions of the Employee","examples":[{"company_deduction":"77.57","employee_deduction":"27.22","name":"Social Security"}]},"taxes":{"anyOf":[{"items":{"$ref":"#/components/schemas/Tax"},"type":"array"},{"type":"null"}],"title":"Taxes","description":"The taxes of the Employee","examples":[{"amount":"175.22","name":"California State Income Tax"}]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","employee","payroll_run","gross_pay","net_pay","start_date","end_date","check_date","earnings","deductions","taxes"],"title":"HrisEmployeePayrollRun","description":"The EmployeePayrollRun object is used to represent an employee's pay statement for a specific payroll run."},"HrisEmployeeResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"employee_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Employee Number","description":"The employee's number that appears in the third-party integration's UI.","examples":["1"]},"company":{"anyOf":[{},{"type":"null"}],"title":"Company","description":"The ID of the employee's company.","examples":["018af1fe-1250-772d-87c5-6f725a579e8a"]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"The employee's first name.","examples":["Kunal"]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Middle Name","description":"The employee's middle name.","examples":["Christopher"]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"The employee's last name.","examples":["Tyagi"]},"preferred_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Preferred Name","description":"The employee's preferred first name.","examples":["Dark Knight"]},"display_full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Full Name","description":"The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.","examples":["Kunal Tyagi"]},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username","description":"The employee's username that appears in the remote UI.","examples":["kunaltyagi"]},"designation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Designation","description":"The employee's current designation/title","examples":["Chief Technology Officer"]},"groups":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Groups","description":"The IDs of the groups that the employee belongs to.","examples":[["018af1fe-1250-772d-87c5-6f725a579e8a","018af1fe-1250-772d-87c5-6f725a579e8b"]]},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Department","description":"The employee's department","examples":["Engineering"]},"division":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Division","description":"The employee's division","examples":["Bangalore Division"]},"work_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Work Email","description":"The employee's work email.","examples":["kunal@bindbee.dev"]},"personal_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Personal Email","description":"The employee's personal email.","examples":["kunaltyagi77@gmail.com"]},"mobile_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mobile Phone Number","description":"The employee's mobile phone number.","examples":["+1234567890"]},"home_phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Home Phone Number","description":"The employee's home phone number.","examples":["+1234567890"]},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code","description":"The employee's country code","examples":["+91"]},"home_location":{"anyOf":[{"$ref":"#/components/schemas/HrisAddress"},{"type":"null"}],"description":"The employee's home address.","examples":[{"city":"London","country":"UK","location":"UK-HO-London","name":"UK-HO-London","postal_code":"56273","state":"LND","street_1":"1011","street_2":"Lane number 4, Golden Villa"}]},"work_location":{"anyOf":[{"$ref":"#/components/schemas/HrisAddress"},{"type":"null"}],"description":"The employee's work address.","examples":[{"city":"London","country":"UK","location":"UK-HO-London","name":"UK-HO-London","postal_code":"56273","state":"LND","street_1":"1011","street_2":"Lane number 4, Golden Villa"}]},"work_locations":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Work Locations","description":"The IDs of the work locations that the employee belongs to.","examples":[["018af1fe-1250-772d-87c5-6f725a579e8a","018af1fe-1250-772d-87c5-6f725a579e8b"]]},"manager":{"anyOf":[{},{"type":"null"}],"title":"Manager","description":"The employee ID of the employee's manager.","examples":["018aeaff-cc7c-7837-988a-965762bd63c1"]},"pay_group":{"anyOf":[{},{"type":"null"}],"title":"Pay Group","description":"The employee's pay group","examples":["018af1fe-1250-77c5-9fcd-4bca1e4568f4"]},"ssn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ssn","description":"The employee's social security number.","examples":["1234567890"]},"gender":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["MALE","FEMALE","NON-BINARY","OTHER","PREFER_NOT_TO_DISCLOSE","-"],"title":"Gender","description":"The employee's gender. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["MALE"]},"ethnicity":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["AMERICAN_INDIAN_OR_ALASKA_NATIVE","ASIAN_OR_INDIAN_SUBCONTINENT","BLACK_OR_AFRICAN_AMERICAN","HISPANIC_OR_LATINO","NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER","TWO_OR_MORE_RACES","WHITE","PREFER_NOT_TO_DISCLOSE","OTHER","-"],"title":"Ethnicity","description":"The employee's ethnicity. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["ASIAN_OR_INDIAN_SUBCONTINENT"]},"marital_status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["SINGLE","MARRIED","DIVORCED","SEPARATED","COMMON_LAW","DOMESTIC_PARTNERSHIP","WIDOWED","HEAD_OF_HOUSEHOLD","QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD","IN_A_RELATIONSHIP","CIVIL_PARTNERSHIP","OTHER","-"],"title":"Marital Status","description":"The employee's filing status as related to marital status. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["SINGLE"]},"tobacco_use":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tobacco Use","description":"Indicates whether the employee uses tobacco or is a smoker.","examples":[true]},"date_of_birth":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Of Birth","description":"The employee's date of birth.","examples":["1986-10-27T00:00:00Z"]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date","description":"The date that the employee started working. If an employee was rehired, the most recent start date will be returned.","examples":["2023-03-05T00:00:00Z"]},"remote_created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Created At","description":"When the third party's employee was created.","examples":["2023-03-01T00:00:00Z"]},"employment_status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["ACTIVE","PENDING","INACTIVE","ACTIVE_EXTERNAL","INACTIVE_EXTERNAL","-","LEAVE","DECEASED","RETIRED"],"title":"Employment Status","description":"The employment status of the employee. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["INACTIVE"]},"termination_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Termination Date","description":"The employee's termination date.","examples":["2023-06-05T00:00:00Z"]},"termination_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Termination Reason","description":"The employee's termination reason.","examples":["Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."]},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatar","description":"The URL of the employee's avatar image.","examples":["http://alturl.com/h2h8m"]},"payroll_run_calendar":{"anyOf":[{},{"type":"null"}],"title":"Payroll Run Calendar","description":"The employee's payroll calendar","examples":["018af1fe-1250-77c5-9fcd-4bca1e4568f4"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields"],"title":"HrisEmployeeResponse"},"HrisEmployerBenefit":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"plan_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plan Name","description":"The name of the plan.","examples":["Medical PPO"]},"provider_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Name","description":"The name of the benefit provider.","examples":["Anthem"]},"benefit_plan_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benefit Plan Type","description":"The type of benefit plan","examples":["Medical"]},"deduction_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deduction Code","description":"The employer benefit's deduction code.","examples":["MEDPPO"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The employer benefit's description.","examples":["Preferred Provider Organization (PPO) plan with medical coverage."]},"benefit_plan_category":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["MEDICAL","VISION","DENTAL","HEALTH_SAVINGS","FLEXIBLE_SPENDING","LIFE_INSURANCE","DISABILITY","SUPPLEMENTAL_INSURANCE","RETIREMENT","WELLNESS","OTHER"],"title":"Benefit Plan Category","description":"The category of the plan. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["MEDICAL"]},"coverage_tiers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"items":{"enum":["WAIVED","EMPLOYEE_ONLY","EMPLOYEE_SPOUSE","EMPLOYEE_CHILD","EMPLOYEE_CHILDREN","EMPLOYEE_FAMILY","EMPLOYEE_DOMESTIC_PARTNER","HSA_FAMILY","SPOUSE","EMPLOYEE_1_DEPENDENT","EMPLOYEE_1_HOUSEHOLD_MEMBER"]},"title":"Coverage Tiers","description":"The coverage tiers for the benefit plan. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["EMPLOYEE_SPOUSE","EMPLOYEE_CHILDREN"]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date","description":"The day and time the benefit started.","examples":["2023-10-18T00:00:00Z"]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date","description":"The day and time the benefit ended.","examples":["2024-10-16T00:00:00Z"]},"payroll_codes":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Payroll Codes","description":"The payroll codes associated with this employer benefit.","examples":[["018abccb-c4a9-72f6-be1d-3fc7aaf2be67"]]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","plan_name","provider_name","benefit_plan_type","deduction_code","description","benefit_plan_category","coverage_tiers","start_date","end_date"],"title":"HrisEmployerBenefit","description":"The Employer Benefit object is used to represent a benefit plan offered by a company."},"HrisEmployment":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"employee":{"anyOf":[{},{"type":"null"}],"title":"Employee","description":"The employee holding this position.","examples":["018abccc-3208-7b2d-8b86-927945f89a42"]},"job_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Title","description":"The position's title.","examples":["Chief Technology Officer"]},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Department","description":"The position's department","examples":["Engineering"]},"division":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Division","description":"The position's division","examples":["Core"]},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date","description":"The position's effective date.","examples":["2023-06-22T00:00:00Z"]},"employment_type":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["FULL_TIME","PART_TIME","INTERN","CONTRACTOR","FREELANCE","REGULAR","FURLOUGHED","TERMINATED","-"],"title":"Employment Type","description":"The position's type of employment. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["FULL_TIME"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields"],"title":"HrisEmployment","description":"The Employment object is used to represent a job position at a company."},"HrisGroup":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The group name.","examples":["Engineering"]},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["COST_CENTER","DEPARTMENT","BUSINESS_UNIT","DIVISION","TEAM"],"title":"Type","description":"The group type.","examples":["DEPARTMENT"]},"parent_group":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Parent Group","description":"The parent group id.","examples":["018af1fe-1250-772d-87c5-6f725a579e8a"]},"is_commonly_used_as_team":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Commonly Used As Team","description":"The group is commonly used as a team.","examples":[true]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","name","type","parent_group","is_commonly_used_as_team"],"title":"HrisGroup","description":"The Group object is used to represent a hierarchy in employees"},"HrisLocation":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the location","examples":["UK-HO-London"]},"street_1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street 1","description":"Street 1","examples":["1011"]},"street_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street 2","description":"Street 2","examples":["Lane number 4, Golden Villa"]},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City","examples":["London"]},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"State","examples":["LND"]},"postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postal Code","description":"Postal Code","examples":["56273"]},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country","examples":["UK"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields"],"title":"HrisLocation"},"HrisPayGroup":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The pay group name.","examples":["Pay Group - USA"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The pay group description","examples":["Pay group for US employees"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","name","description"],"title":"HrisPayGroup","description":"The PayGroup object is used to represent a subset of employees that are put together for payroll processing purposes."},"HrisPayrollCode":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Human-readable name of the payroll code.","examples":["Regular Earnings"]},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Short code identifying the payroll code within the source system.","examples":["REG"]},"type":{"anyOf":[{"$ref":"#/components/schemas/HRISPayrollCodeType"},{"type":"null"}],"enum":["EARNING","DEDUCTION","TAX"],"description":"Category of the payroll code, such as Earning, Deduction, or Tax.","examples":["EARNING"]},"sub_type":{"anyOf":[{"$ref":"#/components/schemas/HRISPayrollCodeSubType"},{"type":"null"}],"enum":["REGULAR","OVERTIME","BONUS","ALLOWANCE","TIME_OFF","SEVERANCE","EQUITY","REIMBURSEMENT","RETRO","HEALTH","DENTAL","VISION","HEALTH_SAVINGS","FLEXIBLE_SPENDING","RETIREMENT","LIFE_INSURANCE","SUPPLEMENTAL_INSURANCE","DISABILITY","GARNISHMENT","FUTA","SUTA","FICA","MEDICARE","FIT","SIT","INCOME_TAX","UNEMPLOYMENT","LEVY","SOCIAL_SECURITY"],"description":"Optional finer-grained classification of the payroll code, drawn from the set allowed for its type. Null when no unified sub-type applies.","examples":["OVERTIME"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","name","code","type","sub_type"],"title":"HrisPayrollCode","description":"The Payroll Code object represents a payroll code such as an earning, deduction, or tax used within the payroll system."},"HrisPayrollRun":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"pay_group":{"anyOf":[{},{"type":"null"}],"title":"Pay Group","description":"The paygroup to which this pay cycle belongs to","examples":["018af1fe-2fad-749e-a282-ea17ba4fc0c4"]},"run_state":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["PAID","DRAFT","APPROVED","FAILED","CLOSED","NOT_STARTED"],"title":"Run State","description":"The state of the payroll run. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["PAID"]},"run_type":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["REGULAR","OFF_CYCLE","CORRECTION","TERMINATION","BONUS","SIGN_ON_BONUS"],"title":"Run Type","description":"The type of the payroll run. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["REGULAR"]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date","description":"The day and time the payroll run started.","examples":["2020-11-08T00:00:00Z"]},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date","description":"The day and time the payroll run ended.","examples":["2020-11-15T00:00:00Z"]},"check_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Check Date","description":"The day and time the payroll run was checked.","examples":["2020-11-15T00:00:00Z"]},"payroll_run_calendar":{"anyOf":[{},{"type":"null"}],"title":"Payroll Run Calendar","description":"The payroll run calendar to which which the payroll run belongs","examples":["018af1fe-2fad-749e-a282-ea17ba4fc0c4"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","pay_group","run_state","run_type","start_date","end_date","check_date","payroll_run_calendar"],"title":"HrisPayrollRun","description":"The PayrollRun object is used to represent a group of pay statements for a specific pay schedule."},"HrisPayrollRunCalendar":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"payroll_run_calendar_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payroll Run Calendar Name","description":"The name of the payroll run calendar","examples":["Monthly Payroll Calendar"]},"pay_group":{"anyOf":[{},{"type":"null"}],"title":"Pay Group","description":"The paygroup to which this pay cycle belongs to","examples":["018af1fe-2fad-749e-a282-ea17ba4fc0c4"]},"pay_period_start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pay Period Start Date","description":"The day and time the payroll run is supposed to start.","examples":["2023-11-01T00:00:00Z"]},"pay_period_end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pay Period End Date","description":"The day and time the payroll run is supposed to end.","examples":["2023-11-30T00:00:00Z"]},"pay_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pay Date","description":"The day and time the by which payment is to be made.","examples":["2023-12-05T00:00:00Z"]},"calendar_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calendar Type","description":"The type of the payroll run calendar","examples":["MONTHLY"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","payroll_run_calendar_name","pay_group","pay_period_start_date","pay_period_end_date","pay_date","calendar_type"],"title":"HrisPayrollRunCalendar","description":"The PayrollRunCalendar object is used to represent a group of pay statements for a specific pay schedule."},"HrisTimeOff":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"employee":{"anyOf":[{},{"type":"null"}],"title":"Employee","description":"The employee requesting time off.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"approver":{"anyOf":[{},{"type":"null"}],"title":"Approver","description":"The Bindbee ID of the employee with the ability to approve the time off request.","examples":["018b4bfb-6065-7f83-b11d-e85ea49e37c3"]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["REQUESTED","APPROVED","DECLINED","CANCELLED","DELETED"],"title":"Status","description":"The status of this time off request. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["APPROVED"]},"employee_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Employee Note","description":"The employee note for this time off request.","examples":["Paid paid vacation! Scuba diving in Hawaii."]},"units":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["HOURS","DAYS"],"title":"Units","description":"The measurement that the third-party integration uses to count time requested. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["HOURS"]},"amount":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Amount","description":"The time off quantity measured by the prescribed “units”.","examples":[12]},"request_type":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["VACATION","SICK","PERSONAL","JURY_DUTY","VOLUNTEER","BEREAVEMENT","MATERNITY","ANNUAL_LEAVE","EMERGENCY_LEAVE","LEAVE_OF_ABSENCE","PATERNITY","PAID_TIME_OFF","LONG_TERM_DISABILITY","SHORT_TERM_DISABILITY","COMP_OFF","WORK_FROM_HOME","COMPASSIONATE","TIME_OFF","FMLA"],"title":"Request Type","description":"The type of time off request. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["VACATION"]},"start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time","description":"The day and time of the start of the time requested off.","examples":["2023-04-10T00:00:00Z"]},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time","description":"The day and time of the end of the time requested off.","examples":["2023-04-10T00:00:00Z"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","employee","approver","status","employee_note","units","amount","request_type","start_time","end_time"],"title":"HrisTimeOff","description":"The TimeOff object is used to represent all employees' Time Off entries."},"HrisTimeOffBalance":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"employee":{"anyOf":[{},{"type":"null"}],"title":"Employee","description":"The employee the balance belongs to.","examples":["018b48d5-79f8-7deb-8813-3e47b375067e"]},"balance":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Balance","description":"The current remaining PTO balance, always measured in terms of hours.","examples":[12]},"used":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Used","description":"The amount of PTO used in terms of hours.","examples":[7]},"policy_type":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["VACATION","SICK","PERSONAL","JURY_DUTY","VOLUNTEER","BEREAVEMENT","MATERNITY","ANNUAL_LEAVE","EMERGENCY_LEAVE","LEAVE_OF_ABSENCE","PATERNITY","PAID_TIME_OFF","LONG_TERM_DISABILITY","SHORT_TERM_DISABILITY","COMP_OFF","WORK_FROM_HOME","COMPASSIONATE","TIME_OFF","FMLA"],"title":"Policy Type","description":"The policy type of this time off balance. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["VACATION"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","employee","balance","used","policy_type"],"title":"HrisTimeOffBalance","description":"The TimeOffBalance object is used to represent current balances for an employee's Time Off plan."},"HrisTimeSheetEntry":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"employee":{"anyOf":[{},{"type":"null"}],"title":"Employee","description":"The employee the timesheet entry is for.","examples":["018abccc-4a0a-7e7d-a9d7-56881f57a6b4"]},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date","description":"The day the time was logged.","examples":["2023-11-10T00:00:00Z"]},"hours_worked":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Hours Worked","description":"The number of hours logged by the employee.","examples":[12.0]},"break_duration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Break Duration","description":"The number of hours the employee took for a break.","examples":[2.5]},"start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time","description":"The day and time of the start of the time entry.","examples":["2023-11-10T00:00:00Z"]},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time","description":"The day and time of the end of the time entry.","examples":["2023-11-10T00:00:00Z"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields","employee","date","hours_worked","break_duration","start_time","end_time"],"title":"HrisTimeSheetEntry","description":"The Timesheet Entry object is used to track coverage for Hours Worked by an Employee."},"IntegrationListItem":{"properties":{"slug":{"type":"string","title":"Slug","description":"Stable identifier for the integration. Use this as `integration_slug` when creating org-level mappings.","examples":["workday"]},"display_name":{"type":"string","title":"Display Name","description":"Human-readable name of the integration.","examples":["Workday"]},"categories":{"items":{"$ref":"#/components/schemas/Category"},"type":"array","title":"Categories","description":"Categories of unified models the org has enabled for this integration.","examples":[["HRIS"]]}},"type":"object","required":["slug","display_name","categories"],"title":"IntegrationListItem"},"IntegrationListResponse":{"properties":{"integrations":{"items":{"$ref":"#/components/schemas/IntegrationListItem"},"type":"array","title":"Integrations"}},"type":"object","required":["integrations"],"title":"IntegrationListResponse"},"IntegrationResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Id of the integration object","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"integration_id":{"type":"string","format":"uuid","title":"Integration Id","description":"Id of the integration","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"is_enabled":{"type":"boolean","title":"Is Enabled","description":"Enabled boolean flag","examples":[true]},"integration_slug":{"type":"string","title":"Integration Slug","description":"Integration slug","examples":["ukg_pro"]},"integration_type":{"type":"string","title":"Integration Type","description":"Integration Type","examples":["API"]},"category":{"type":"string","title":"Category","description":"Categories this integration falls into","examples":["HRIS"]},"display_name":{"type":"string","title":"Display Name","description":"Name of the integration","examples":["BambooHR"]},"icon_url":{"type":"string","title":"Icon Url","description":"The url for icon","examples":["https://images.unifyx.dev/logos/icon/ats/recruitee.svg"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description of integration","examples":["BambooHR is an intuitive HRIS solution designed to streamline HR processes, offering features for employee onboarding, performance management, and HR analytics, providing organizations with a user-friendly platform for effective workforce management."]}},"type":"object","required":["id","integration_id","is_enabled","integration_slug","integration_type","category","display_name","icon_url","description"],"title":"IntegrationResponse"},"JobDisplayStatus":{"type":"string","enum":["Syncing","Done","Failed"],"title":"JobDisplayStatus"},"LinkTokenCreate":{"properties":{"end_user_data":{"$ref":"#/components/schemas/EndUserCreate","title":"End user data","description":"End user data"},"category":{"$ref":"#/components/schemas/UnifiedApiCategory","title":"Categories","description":"Categories which will be shown in unify link","examples":["HRIS"]},"integration":{"type":"string","title":"Integration","description":"Integration slug of the integration","examples":["bamboohr"]}},"type":"object","required":["end_user_data","category","integration"],"title":"LinkTokenCreate"},"LinkTokenResponse":{"properties":{"link_token":{"type":"string","title":"Link Token","description":"Link token to be used for generating unify link","examples":["KJDXZk8zC8Tdr-suQCy7zkALZVLjhKXyMd83leqheEGQpBx_evXrHA"]}},"type":"object","required":["link_token"],"title":"LinkTokenResponse"},"LmsCategory":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the category","examples":["Programming"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the category","examples":["All programming topics"]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["ACTIVE","PENDING","INACTIVE"],"title":"Status","description":"The status of the category. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["ACTIVE"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields"],"title":"LmsCategory"},"LmsCompletion":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"user":{"anyOf":[{},{"type":"null"}],"title":"User","description":"The user who completed the course","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"course":{"anyOf":[{},{"type":"null"}],"title":"Course","description":"The course that the user completed","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"content":{"anyOf":[{},{"type":"null"}],"title":"Content","description":"The content that the user completed","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Score","description":"The score obtained by the user","examples":[95]},"grade":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["A","B","C","D","F","PASS","FAIL","-"],"title":"Grade","description":"The grade achieved by the user. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["PASS"]},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Started At","description":"The date and time when the user started the course","examples":["2025-08-01T10:00:00Z"]},"completed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completed At","description":"The date and time when the user completed the course","examples":["2025-08-01T11:15:00Z"]},"time_duration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Time Duration","description":"The time duration of the course used by the user in ISO 8601 format","examples":["PT1H15M"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields"],"title":"LmsCompletion"},"LmsContent":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The title of the content","examples":["NumPy Basics"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the content","examples":["Array manipulation"]},"languages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"items":{"enum":["wae_CH","ar_SY","xh_ZA","ar_EG","fr_CH","no_NO","pt_PT","hy_AM","es_CR","th_TH","ks_IN","ar_AA","ik_CA","wa_BE","oc_FR","en_EN","tpi_PG","miq_NI","rw_RW","bn_BD","ka_GE","ug_CN","ta_LK","ar_SS","ru_UA","ee_EE","hsb_DE","ar_MA","nr_ZA","sh_HR","el_GR","de_DE","br_FR","pap_CW","quz_PE","ar_QA","the_NP","is_IS","es_NI","hif_FJ","csb_PL","en_BW","es_EC","sw_TZ","yue_HK","st_ZA","byn_ER","ro_RO","en_BE","km_KH","yi_US","de_IT","gv_GB","aa_ER","ss_ZA","uk_UA","it_IT","nl_NL","ti_ET","hu_HU","en_IE","sl_SI","ph_PH","ar_TN","de_BE","ig_NG","nso_ZA","sc_IT","ar_AE","sid_ET","fr_LU","en_HK","mni_IN","es_AR","sw_KE","et_EE","tr_TR","nhn_MX","ur_PK","bo_CN","mhr_RU","li_BE","ayc_PE","so_KE","niu_NU","eo_XX","lo_LA","tl_PH","so_SO","lt_LT","lv_LV","cy_GB","wo_SN","it_CH","ky_KG","es_CO","fy_NL","iu_CA","ar_YE","en_ZW","ca_FR","ar_IQ","gu_IN","zh_HK","iw_IL","nb_NO","ca_AD","sa_IN","tk_TM","mg_MG","ny_NO","nan_TW","wal_ET","ru_RU","mag_IN","to_TO","tcy_IN","bg_BG","sgs_LT","pd_US","ja_JP","an_ES","pap_AW","fi_FI","en_NZ","ia_FR","en_ZS","vi_VN","kl_GL","sv_FI","gez_ET","es_US","tt_RU","en_AG","si_LK","eo_US","or_IN","hak_TW","sm_WS","en_SC","es_UY","he_IL","da_DK","es_PA","ff_SN","es_BO","hi_IN","sr_ME","gd_GB","tig_ER","shs_CA","mi_NZ","te_IN","mai_IN","unm_US","ht_HT","id_ID","zh_CN","fur_IT","en_ZA","nds_DE","be_BY","niu_NZ","ga_IE","bho_IN","fr_CA","mr_IN","sk_SK","shn_MM","raj_IN","es_CU","se_NO","es_VE","sd_IN","fil_PH","mai_NP","dv_MV","bem_ZM","bho_NP","zh_TW","crh_UA","lb_LU","eo","es_PE","sr_CS","aa_ET","zu_ZA","de_LI","en_PH","C","ber_DZ","en_IL","de_AT","my_MM","gez_ER","en_NG","en_DL","sv_SE","ca_IT","sr_RS","lij_IT","ku_TR","ak_GH","en_AU","ti_ER","brx_IN","so_DJ","ms_MY","os_RU","pa_IN","ar_SA","ta_IN","ar_LY","eo_EO","eu_ES","es_PR","chr_US","ar_OM","yuw_PG","ha_NG","sl_CS","gl_ES","mn_MN","mjw_IN","es_DO","lg_UG","ps_AF","el_CY","mk_MK","pt_BR","sd_PK","ar_BH","eu_FR","agr_PE","ln_CD","fa_IR","ber_MA","ar_SD","en_GB","es_ES","ar_JO","es_HN","li_NL","sq_MK","mt_MT","fr_FR","az_AZ","uz_UZ","af_ZA","bn_IN","szl_PL","lzh_TW","doi_IN","zh_SG","kn_IN","bi_VU","nl_BE","bs_BA","kok_IN","bhb_IN","ca_ES","so_ET","tg_TJ","de_CH","de_LU","mfe_MU","cv_RU","pl_PL","om_KE","tr_CY","yo_NG","nl_AW","nn_NO","as_IN","ar_IN","nds_NL","ts_ZA","pa_PK","tn_ZA","pap_AN","es_PY","cs_CZ","fr_BE","ar_KW","ce_RU","ml_IN","es_GT","kw_GB","aa_DJ","ckb_IQ","fy_DE","ur_IN","es_CL","ve_ZA","en_SG","ko_KR","sq_AL","cmn_TW","en_CA","en_IN","en_ZM","bo_IN","anp_IN","hr_HR","ia","om_ET","sat_IN","es_MX","ast_ES","en_US","ar_LB","fo_FO","am_ET","az_IR","pp_AN","ne_NP","ar_DZ","es_SV","kab_DZ","hne_IN","en_DK","dz_BT","pd_DE","kk_KZ"]},"title":"Languages","description":"The languages of the content as locale codes (e.g. en_US, fr_FR, de_DE).","examples":[["en_US","en_GB"]]},"cover_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cover Image","description":"The URL of the cover image of the content","examples":["https://img.example.com/numpy.png"]},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"The URL of the content","examples":["https://lms.example.com/content/numpy"]},"duration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Duration","description":"The duration of the content in ISO 8601 format","examples":["PT45M"]},"categories":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Categories","description":"The categories of the content","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"skills":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Skills","description":"The skills of the content","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"courses":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Courses","description":"The courses that the content belongs to","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Order","description":"Order of the content inside a course","examples":[1]},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider","description":"The provider of the content","examples":["Coursera"]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["ACTIVE","PENDING","INACTIVE"],"title":"Status","description":"The status of the content. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["ACTIVE"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields"],"title":"LmsContent"},"LmsCourse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the course","examples":["Python for Data Science"]},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the course","examples":["Introductory course"]},"cover_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cover Image","description":"The URL of the cover image of the course","examples":["https://img.example.com/py.png"]},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"The URL of the course","examples":["https://lms.example.com/course/py"]},"duration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Duration","description":"The duration of the course in ISO 8601 format","examples":["PT5H30M"]},"languages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"items":{"enum":["wae_CH","ar_SY","xh_ZA","ar_EG","fr_CH","no_NO","pt_PT","hy_AM","es_CR","th_TH","ks_IN","ar_AA","ik_CA","wa_BE","oc_FR","en_EN","tpi_PG","miq_NI","rw_RW","bn_BD","ka_GE","ug_CN","ta_LK","ar_SS","ru_UA","ee_EE","hsb_DE","ar_MA","nr_ZA","sh_HR","el_GR","de_DE","br_FR","pap_CW","quz_PE","ar_QA","the_NP","is_IS","es_NI","hif_FJ","csb_PL","en_BW","es_EC","sw_TZ","yue_HK","st_ZA","byn_ER","ro_RO","en_BE","km_KH","yi_US","de_IT","gv_GB","aa_ER","ss_ZA","uk_UA","it_IT","nl_NL","ti_ET","hu_HU","en_IE","sl_SI","ph_PH","ar_TN","de_BE","ig_NG","nso_ZA","sc_IT","ar_AE","sid_ET","fr_LU","en_HK","mni_IN","es_AR","sw_KE","et_EE","tr_TR","nhn_MX","ur_PK","bo_CN","mhr_RU","li_BE","ayc_PE","so_KE","niu_NU","eo_XX","lo_LA","tl_PH","so_SO","lt_LT","lv_LV","cy_GB","wo_SN","it_CH","ky_KG","es_CO","fy_NL","iu_CA","ar_YE","en_ZW","ca_FR","ar_IQ","gu_IN","zh_HK","iw_IL","nb_NO","ca_AD","sa_IN","tk_TM","mg_MG","ny_NO","nan_TW","wal_ET","ru_RU","mag_IN","to_TO","tcy_IN","bg_BG","sgs_LT","pd_US","ja_JP","an_ES","pap_AW","fi_FI","en_NZ","ia_FR","en_ZS","vi_VN","kl_GL","sv_FI","gez_ET","es_US","tt_RU","en_AG","si_LK","eo_US","or_IN","hak_TW","sm_WS","en_SC","es_UY","he_IL","da_DK","es_PA","ff_SN","es_BO","hi_IN","sr_ME","gd_GB","tig_ER","shs_CA","mi_NZ","te_IN","mai_IN","unm_US","ht_HT","id_ID","zh_CN","fur_IT","en_ZA","nds_DE","be_BY","niu_NZ","ga_IE","bho_IN","fr_CA","mr_IN","sk_SK","shn_MM","raj_IN","es_CU","se_NO","es_VE","sd_IN","fil_PH","mai_NP","dv_MV","bem_ZM","bho_NP","zh_TW","crh_UA","lb_LU","eo","es_PE","sr_CS","aa_ET","zu_ZA","de_LI","en_PH","C","ber_DZ","en_IL","de_AT","my_MM","gez_ER","en_NG","en_DL","sv_SE","ca_IT","sr_RS","lij_IT","ku_TR","ak_GH","en_AU","ti_ER","brx_IN","so_DJ","ms_MY","os_RU","pa_IN","ar_SA","ta_IN","ar_LY","eo_EO","eu_ES","es_PR","chr_US","ar_OM","yuw_PG","ha_NG","sl_CS","gl_ES","mn_MN","mjw_IN","es_DO","lg_UG","ps_AF","el_CY","mk_MK","pt_BR","sd_PK","ar_BH","eu_FR","agr_PE","ln_CD","fa_IR","ber_MA","ar_SD","en_GB","es_ES","ar_JO","es_HN","li_NL","sq_MK","mt_MT","fr_FR","az_AZ","uz_UZ","af_ZA","bn_IN","szl_PL","lzh_TW","doi_IN","zh_SG","kn_IN","bi_VU","nl_BE","bs_BA","kok_IN","bhb_IN","ca_ES","so_ET","tg_TJ","de_CH","de_LU","mfe_MU","cv_RU","pl_PL","om_KE","tr_CY","yo_NG","nl_AW","nn_NO","as_IN","ar_IN","nds_NL","ts_ZA","pa_PK","tn_ZA","pap_AN","es_PY","cs_CZ","fr_BE","ar_KW","ce_RU","ml_IN","es_GT","kw_GB","aa_DJ","ckb_IQ","fy_DE","ur_IN","es_CL","ve_ZA","en_SG","ko_KR","sq_AL","cmn_TW","en_CA","en_IN","en_ZM","bo_IN","anp_IN","hr_HR","ia","om_ET","sat_IN","es_MX","ast_ES","en_US","ar_LB","fo_FO","am_ET","az_IR","pp_AN","ne_NP","ar_DZ","es_SV","kab_DZ","hne_IN","en_DK","dz_BT","pd_DE","kk_KZ"]},"title":"Languages","description":"The languages of the course as locale codes (e.g. en_US, fr_FR, de_DE).","examples":[["en_US","fr_FR"]]},"categories":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Categories","description":"The categories of the course","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"contents":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Contents","description":"The contents of the course","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"skills":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Skills","description":"The skills of the course","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"instructors":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Instructors","description":"The instructors of the course","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["ACTIVE","PENDING","INACTIVE"],"title":"Status","description":"The status of the course. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["ACTIVE"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields"],"title":"LmsCourse"},"LmsEnrollment":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"user":{"anyOf":[{},{"type":"null"}],"title":"User","description":"The user who is enrolled in the course","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"course":{"anyOf":[{},{"type":"null"}],"title":"Course","description":"The course that the user is enrolled in","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date","description":"The date and time when the user started the course","examples":["2025-08-01T10:00:00Z"]},"completion":{"anyOf":[{},{"type":"null"}],"title":"Completion","description":"The completion of the course","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields"],"title":"LmsEnrollment"},"LmsSkill":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the skill","examples":["Data Analysis"]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["ACTIVE","PENDING","INACTIVE"],"title":"Status","description":"The status of the skill. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["ACTIVE"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields"],"title":"LmsSkill"},"LmsUser":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","examples":["018b18ef-c487-703c-afd9-0ca478ccd9d6"]},"remote_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remote Id","description":"The third-party API ID of the matching object.","examples":["123321"]},"modified_at":{"type":"string","format":"date-time","title":"Modified At","description":"This is the datetime that this object was last updated by Bindbee","examples":["2021-10-16T00:00:00Z"]},"raw_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Data","description":"This is the Raw data","examples":[{"key_1":"Platform dependent data 1","key_2":"Platform dependent data 2"}]},"custom_fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Custom Fields","description":"The custom fields related to the model","examples":[{"category_group":"REG","disability_type":"ASBERG","hire_date":"1991-03-16T00:00:00","hire_source":"REFER","nationality":"USA","original_hire_date":"1991-03-16T00:00:00"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"The first name of the user","examples":["Jane"]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"The last name of the user","examples":["Doe"]},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Middle Name","description":"The middle name of the user","examples":["A."]},"email_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Address","description":"The email address of the user","examples":["jane.doe@example.com"]},"phone_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone Number","description":"The phone number of the user","examples":["+1 415 555 1212"]},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["ACTIVE","PENDING","INACTIVE"],"title":"Status","description":"The status of the user. If the value is not one of the defined enum values, the original value passed through will be returned.","examples":["ACTIVE"]}},"type":"object","required":["id","remote_id","modified_at","custom_fields"],"title":"LmsUser"},"MetaApiResponseModel":{"properties":{"success":{"type":"boolean","title":"Success"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data"},"error":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Error"}},"type":"object","required":["success"],"title":"MetaApiResponseModel"},"ModelListItem":{"properties":{"slug":{"type":"string","title":"Slug","description":"Stable identifier for the model. Use this as `model` when creating custom fields or mappings.","examples":["employee"]},"display_name":{"type":"string","title":"Display Name","description":"Human-readable name of the model.","examples":["Employee"]},"category":{"$ref":"#/components/schemas/Category","description":"Category this model belongs to.","examples":["HRIS"]}},"type":"object","required":["slug","display_name","category"],"title":"ModelListItem"},"ModelListResponse":{"properties":{"models":{"items":{"$ref":"#/components/schemas/ModelListItem"},"type":"array","title":"Models"}},"type":"object","required":["models"],"title":"ModelListResponse"},"PaginatedResponse_AtsActivity_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsActivity"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsActivity]"},"PaginatedResponse_AtsApplication_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsApplication"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsApplication]"},"PaginatedResponse_AtsAttachment_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsAttachment"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsAttachment]"},"PaginatedResponse_AtsCandidate_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsCandidate"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsCandidate]"},"PaginatedResponse_AtsDepartment_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsDepartment"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsDepartment]"},"PaginatedResponse_AtsEEOC_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsEEOC"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsEEOC]"},"PaginatedResponse_AtsJobInterviewStage_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsJobInterviewStage"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsJobInterviewStage]"},"PaginatedResponse_AtsJob_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsJob"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsJob]"},"PaginatedResponse_AtsOffer_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsOffer"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsOffer]"},"PaginatedResponse_AtsOffice_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsOffice"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsOffice]"},"PaginatedResponse_AtsRejectReason_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsRejectReason"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsRejectReason]"},"PaginatedResponse_AtsRemoteUser_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsRemoteUser"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsRemoteUser]"},"PaginatedResponse_AtsScheduledInterview_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsScheduledInterview"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsScheduledInterview]"},"PaginatedResponse_AtsScorecard_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsScorecard"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsScorecard]"},"PaginatedResponse_AtsScreeningQuestion_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsScreeningQuestion"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsScreeningQuestion]"},"PaginatedResponse_AtsTag_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/AtsTag"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[AtsTag]"},"PaginatedResponse_ConnectorResponse_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/ConnectorResponse"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[ConnectorResponse]"},"PaginatedResponse_CustomFieldExternal_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/CustomFieldExternal"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[CustomFieldExternal]"},"PaginatedResponse_HrisBankInfo_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisBankInfo"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisBankInfo]"},"PaginatedResponse_HrisBenefitCoverage_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisBenefitCoverage"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisBenefitCoverage]"},"PaginatedResponse_HrisBenefit_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisBenefit"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisBenefit]"},"PaginatedResponse_HrisCompany_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisCompany"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisCompany]"},"PaginatedResponse_HrisCompensation_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisCompensation"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisCompensation]"},"PaginatedResponse_HrisConnectorResponse_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisConnectorResponse"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisConnectorResponse]"},"PaginatedResponse_HrisDependentBenefit_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisDependentBenefit"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisDependentBenefit]"},"PaginatedResponse_HrisDependent_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisDependent"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisDependent]"},"PaginatedResponse_HrisEmployeePayrollRun_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisEmployeePayrollRun"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisEmployeePayrollRun]"},"PaginatedResponse_HrisEmployeeResponse_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisEmployeeResponse"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisEmployeeResponse]"},"PaginatedResponse_HrisEmployerBenefit_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisEmployerBenefit"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisEmployerBenefit]"},"PaginatedResponse_HrisEmployment_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisEmployment"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisEmployment]"},"PaginatedResponse_HrisGroup_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisGroup"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisGroup]"},"PaginatedResponse_HrisLocation_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisLocation"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisLocation]"},"PaginatedResponse_HrisPayGroup_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisPayGroup"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisPayGroup]"},"PaginatedResponse_HrisPayrollCode_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisPayrollCode"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisPayrollCode]"},"PaginatedResponse_HrisPayrollRunCalendar_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisPayrollRunCalendar"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisPayrollRunCalendar]"},"PaginatedResponse_HrisPayrollRun_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisPayrollRun"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisPayrollRun]"},"PaginatedResponse_HrisTimeOffBalance_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisTimeOffBalance"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisTimeOffBalance]"},"PaginatedResponse_HrisTimeOff_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisTimeOff"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisTimeOff]"},"PaginatedResponse_HrisTimeSheetEntry_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/HrisTimeSheetEntry"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[HrisTimeSheetEntry]"},"PaginatedResponse_IntegrationResponse_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/IntegrationResponse"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[IntegrationResponse]"},"PaginatedResponse_LmsCategory_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/LmsCategory"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[LmsCategory]"},"PaginatedResponse_LmsCompletion_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/LmsCompletion"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[LmsCompletion]"},"PaginatedResponse_LmsContent_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/LmsContent"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[LmsContent]"},"PaginatedResponse_LmsCourse_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/LmsCourse"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[LmsCourse]"},"PaginatedResponse_LmsEnrollment_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/LmsEnrollment"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[LmsEnrollment]"},"PaginatedResponse_LmsSkill_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/LmsSkill"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[LmsSkill]"},"PaginatedResponse_LmsUser_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/LmsUser"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[LmsUser]"},"PaginatedResponse_WebhookListItemExternal_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/WebhookListItemExternal"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[WebhookListItemExternal]"},"PaginatedResponse_WebhookLogEntryExternal_":{"properties":{"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor value to fetch next set of items","examples":["MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"]},"page_size":{"type":"integer","title":"Page Size","description":"Indicates the count of items in the response","examples":[50]},"items":{"items":{"$ref":"#/components/schemas/WebhookLogEntryExternal"},"type":"array","title":"Items","description":"List of items in the current response"}},"type":"object","required":["cursor","page_size","items"],"title":"PaginatedResponse[WebhookLogEntryExternal]"},"PassThroughRequest":{"properties":{"method":{"$ref":"#/components/schemas/HTTPMethod-Input","title":"method","description":"Method of the request","examples":["POST"]},"path":{"type":"string","title":"path","description":"Path of the request","examples":["/employees"]},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"headers","description":"headers of the request","examples":[{"Content-Type":"application/json"}]},"params":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"params","description":"params of the request","examples":[{"a":1,"b":2}]},"data":{"anyOf":[{"type":"string"},{"items":{},"type":"array"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"data","description":"Body of the request","examples":[{"a":1,"b":2}]},"request_format":{"anyOf":[{"$ref":"#/components/schemas/RequestFormatEnum"},{"type":"null"}],"title":"Request Format","description":"format of the request","default":"JSON","examples":["JSON"]},"response_format":{"anyOf":[{"$ref":"#/components/schemas/ResponseFormatEnum"},{"type":"null"}],"title":"Response Format","description":"format of the response","default":"JSON","examples":["JSON"]},"timeout":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Timeout","description":"timeout of the request","examples":[300.0]}},"type":"object","required":["method","path","headers"],"title":"PassThroughRequest"},"PostCandidate":{"properties":{"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"The candidate's first name.","examples":["John"]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"The candidate's last name.","examples":["Doe"]},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company","description":"The name of the company where candidate has applied.","examples":["Google"]},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The position for which the candidate has applied","examples":["SOFTWARE ENGINEER"]},"is_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Private","description":"Whether the candidate's information is private.","examples":[true]},"can_email":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Can Email","description":"Whether the candidate can be emailed.","examples":[true]},"locations":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Locations","description":"The location of the candidate.","examples":["San Francisco","New York"]},"phone_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Phone Numbers","description":"The candidate's phone numbers.","examples":["123-456-7890"]},"email_addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Email Addresses","description":"The candidate's email addresses.","examples":["john@doe.com"]},"urls":{"anyOf":[{"items":{"$ref":"#/components/schemas/AtsUrl"},"type":"array"},{"type":"null"}],"title":"Urls","description":"The candidate's URLs. This can include a personal website, LinkedIn profile, or other relevant URLs.","examples":[{"type":"LINKEDIN","value":"https://www.linkedin.com/in/johndoe"}]},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","description":"The candidate's tags. Tags are used to categorize candidates and can be used to filter candidates in the UI.","examples":["JUNIOR","INTERMEDIATE"]},"applications":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Applications","description":"The candidate's applications.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"attachments":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Attachments","description":"The candidate's attachments.","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatar","description":"The candidate's avatar.","examples":["https://www.example.com/avatar.jpg"]},"job_interview_stage_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Job Interview Stage Id","description":"The job stage id for the candidate","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]},"job_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Job Id","description":"The job id for the candidate","examples":["018b4bfb-5ece-70b1-ad5e-862a9433aa65"]}},"type":"object","title":"PostCandidate"},"RequestFormatEnum":{"type":"string","enum":["JSON","XML","MULTIPART"],"title":"RequestFormatEnum"},"ResponseFormatEnum":{"type":"string","enum":["JSON","XML","MULTIPART","BINARY"],"title":"ResponseFormatEnum"},"SuccessMessageResponseModel":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"SuccessMessageResponseModel"},"Tax":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The tax's name.","examples":["California State Income Tax"]},"amount":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Amount","description":"The tax amount.","examples":[175.22]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"The currency of the tax amount.","examples":["USD"]},"payroll_code":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Payroll Code","description":"The ID of the payroll code associated with this tax.","examples":["019fbd01-e5ea-7d5a-a602-bd9016a271cc"]}},"type":"object","required":["name","amount"],"title":"Tax"},"UnifiedApiCategory":{"type":"string","enum":["HRIS","ATS","CUSTOM","LMS"],"title":"UnifiedApiCategory"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WebhookActions":{"type":"string","enum":["connector_synced","connector_sync_started","connector_data_modified","employee_data_changed","connector_sync_error"],"title":"WebhookActions"},"WebhookListItemExternal":{"properties":{"webhook_id":{"type":"string","format":"uuid","title":"Webhook Id","description":"Unique identifier of the webhook.","examples":["018e586b-7d0b-7bc9-be65-a8fdbc82d734"]},"name":{"type":"string","title":"Name","description":"Name of the webhook."},"url":{"type":"string","title":"Url","description":"URL the webhook is delivered to."},"is_enabled":{"type":"boolean","title":"Is Enabled","description":"Whether the webhook is currently enabled."},"for_test_connector":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"For Test Connector","description":"Whether this webhook is scoped to a demo/test connector."},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"last_triggered_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Triggered At","description":"When this webhook last fired, if ever."}},"type":"object","required":["webhook_id","name","url","is_enabled"],"title":"WebhookListItemExternal"},"WebhookLogDetailExternal":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the delivery attempt."},"connector_id":{"type":"string","format":"uuid","title":"Connector Id","description":"Connector this delivery was triggered for."},"method":{"anyOf":[{"$ref":"#/components/schemas/HTTPMethod-Output"},{"type":"null"}],"description":"HTTP method used to deliver the webhook."},"url":{"type":"string","title":"Url","description":"URL the webhook was delivered to."},"response_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Response Code","description":"HTTP status code returned by the receiving endpoint."},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"integration_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Name","description":"Integration of the connector that triggered this delivery."},"end_user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End User Name","description":"End user of the connector that triggered this delivery."},"origin_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin Id","description":"Origin ID of the end user associated with the connector."},"webhook_action":{"anyOf":[{"$ref":"#/components/schemas/WebhookActions"},{"type":"null"}],"description":"Event that triggered this delivery."},"webhook_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Name","description":"Name of the webhook."},"request":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Request","description":"Request sent to the webhook url."},"response":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Response","description":"Response received from the webhook url."}},"type":"object","required":["id","connector_id","url"],"title":"WebhookLogDetailExternal"},"WebhookLogEntryExternal":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"Unique identifier of the delivery attempt."},"connector_id":{"type":"string","format":"uuid","title":"Connector Id","description":"Connector this delivery was triggered for."},"method":{"anyOf":[{"$ref":"#/components/schemas/HTTPMethod-Output"},{"type":"null"}],"description":"HTTP method used to deliver the webhook."},"url":{"type":"string","title":"Url","description":"URL the webhook was delivered to."},"response_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Response Code","description":"HTTP status code returned by the receiving endpoint."},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"integration_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration Name","description":"Integration of the connector that triggered this delivery."},"end_user_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End User Name","description":"End user of the connector that triggered this delivery."},"origin_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Origin Id","description":"Origin ID of the end user associated with the connector."},"webhook_action":{"anyOf":[{"$ref":"#/components/schemas/WebhookActions"},{"type":"null"}],"description":"Event that triggered this delivery."},"webhook_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Webhook Name","description":"Name of the webhook."}},"type":"object","required":["id","connector_id","url"],"title":"WebhookLogEntryExternal","description":"Client-facing webhook delivery entry. Omits dashboard-only image fields and\ngeneric log fields that webhook deliveries never populate (model_id,\nsync_job_id, status), with webhook_action/method typed against their enums."},"ErrorResponse":{"type":"object","required":["detail"],"properties":{"detail":{"type":"string"}}}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}}}