Bindbee Unified API

{"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"

# --- truncated at 32 KB (691 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bindbee/refs/heads/main/openapi/bindbee-unified-api-openapi.json