openapi: 3.2.0 info: title: Bindbee EEOC API version: 0.1.0 tags: - name: EEOC paths: /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' components: schemas: ErrorResponse: type: object required: - detail properties: detail: type: string 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 HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError 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. 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] securitySchemes: HTTPBearer: type: http scheme: bearer