Guides
Signup For Free

Fountain API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for Fountain API as part of the ATS category

Delete API Key

  • ID: delete_api_key
  • Operation: write
  • Entities: apikey
  • Summary: The Delete API Key endpoint allows users to delete an API key by providing its unique identifier in the path parameters. The request method is DELETE, and it requires the 'identifier' path parameter, which is a UUID representing the API key to be deleted. The request can include an 'accept' header to specify the desired response format, though it is optional. Upon successful deletion, the API returns a JSON object containing metadata about the request, such as timestamp, HTTP verb, path, status, and duration. In case of an error, a detailed error message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete API Keys with Filtering

  • ID: delete_api_keys_with_filtering
  • Operation: write
  • Entities: apikey
  • Summary: This API endpoint allows the deletion of multiple API keys based on specified filtering criteria. The DELETE method is used to perform this operation. The request can include query parameters for filtering, specifically a 'filter' object. The response will include metadata about the operation, such as timestamp, HTTP verb, path, and status. In case of an error, a detailed error message will be provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Applicant Information

  • ID: delete_applicant_information
  • Operation: write
  • Entities: applicant
  • Summary: This API endpoint allows you to delete an applicant and their information permanently by specifying the applicant's ID in the path parameters. The request requires an 'accept' header with the value 'application/json'. The response will be a 204 status code indicating success, or a 401 status code indicating unauthorized access. Use this endpoint with caution as it will permanently delete the applicant's data. If unsure about deletion, consider moving the applicant to a different stage or assigning a label instead.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Applicant Note

  • ID: delete_applicant_note
  • Operation: write
  • Entities: applicant, note
  • Summary: The Delete Applicant Note API allows users to delete a specific note associated with an applicant. The API requires two path parameters: 'id', which is the ID of the applicant, and 'note_id', which is the ID of the note to be deleted. The request must include an 'accept' header specifying 'application/json'. Upon successful deletion, the API returns a 200 status code with a confirmation message. If unauthorized access occurs, a 401 status code is returned with an error object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Destroy Calendar Slot by ID

  • ID: delete_calendar_slot_by_id
  • Operation: write
  • Entities: calendar slot
  • Summary: This API endpoint is used to destroy a calendar slot identified by a unique ID. The request is made using the DELETE method to the URL 'https://api.fountain.com/v2/available_slots/{id}'. The path parameter 'id' is required and specifies the ID of the available slot to be deleted. An optional query parameter 'delete_all_siblings' can be set to true to destroy all slots with the same key. The request header can include 'accept: application/json' to specify the desired response format. The API returns a 200 OK response with a string if successful, a 401 Unauthorized response if the request is not authorized, and a 404 Not Found response if the slot ID does not exist.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Custom Attribute

  • ID: delete_custom_attribute
  • Operation: write
  • Entities: custom attribute
  • Summary: The Delete Custom Attribute API allows users to delete a custom attribute identified by a unique identifier. The API requires the 'identifier' path parameter, which is a UUID representing the custom attribute to be deleted. The request should include an 'accept' header specifying 'application/json' as the acceptable response format. Upon successful deletion, the API returns a JSON object containing metadata about the request, including a timestamp, HTTP verb, path, request identifiers, count of affected items, status code, and request duration. In case of an error, an error message is returned detailing the issue.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Custom Attributes with Filtering

  • ID: delete_custom_attributes_with_filtering
  • Operation: write
  • Entities: custom attribute
  • Summary: This API endpoint allows the deletion of multiple custom attributes using filtering criteria. The request is made using the DELETE method to the specified URL. The request can include query parameters for filtering the custom attributes to be deleted. The response will indicate the status of the deletion operation, wrapped in a JsonAPI root response. In case of an error, a default error response is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Data Group

  • ID: delete_data_group
  • Operation: write
  • Entities: data group
  • Summary: The Delete Data Group API allows you to delete a specific data group identified by a unique identifier. The API requires the 'identifier' path parameter, which is a UUID representing the data group to be deleted. The request does not require a body or additional query parameters. The response will return a status of the deletion wrapped in a JsonAPI root response if successful, or a default error response if there is a server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete DataGroups with Filtering

  • ID: delete_datagroups_with_filtering
  • Operation: write
  • Entities: data group
  • Summary: This API endpoint allows the deletion of multiple dataGroups using specified filtering criteria. The DELETE method is used to perform this operation. The request can include query parameters for filtering, and the response will provide metadata about the deletion operation, including a timestamp, HTTP verb, path, unique identifiers for the request and response, the count of items affected, status code, and duration. In case of an error, an error message will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete EIN

  • ID: delete_ein
  • Operation: write
  • Entities: service organization, ein
  • Summary: The Delete EIN API allows you to delete a specific EIN (Employer Identification Number) using its unique identifier. The API requires the 'identifier' path parameter, which is a UUID representing the EIN to be deleted. The request must include an 'accept' header with the value 'application/json'. Upon successful deletion, the API returns a 200 status code with a JSON object containing metadata. If an error occurs, a 500 status code is returned with a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Employer

  • ID: delete_employer
  • Operation: write
  • Entities: employer
  • Summary: This API endpoint allows the deletion of an employer using a DELETE request. The request requires a path parameter 'identifier', which is the unique identifier of the employer in UUID format. The request header can optionally include 'accept' with the value 'application/json'. The response will return a status of the deletion wrapped in a JsonAPI root response if successful (HTTP 200) or a default error response (HTTP 500) if there is an error. No response example is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Employers with Filtering

  • ID: delete_employers_with_filtering
  • Operation: write
  • Entities: employer
  • Summary: This API endpoint allows for the deletion of multiple employers based on specified filtering criteria. The request is made using the DELETE method to the URL https://wxp-services.fountain.com/api/servicestaff/employers. The request can include query parameters for filtering, specifically a 'filter' object that defines the criteria for which employers should be deleted. The request header can specify 'accept: application/json' to indicate the desired response format. The response will include metadata about the delete operation if successful, or an error message if unsuccessful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Existing Hiring Goal

  • ID: delete_existing_hiring_goal
  • Operation: write
  • Entities: hiring goal
  • Summary: This API endpoint allows the user to delete an existing Hiring Goal by specifying the Hiring Goal ID in the path parameters. The request method is DELETE, and it requires an 'accept' header specifying 'application/json'. The response can be a 204 No Content if successful, 401 Unauthorized if the user is not authorized, 404 Not Found if the Hiring Goal ID does not exist, or 501 NotImplemented for other errors. The response body for errors includes a message detailing the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Existing Location

  • ID: delete_existing_location
  • Operation: write
  • Entities: location
  • Summary: This API endpoint allows the user to delete an existing location by specifying the location ID in the path parameters. The request method is DELETE, and it requires the 'id' path parameter to identify the location to be deleted. The request can include an 'accept' header to specify the desired response format, which defaults to 'application/json'. The API returns a 204 status code with no content if the deletion is successful. If the request is unauthorized, a 401 status code is returned with an error message. If the location is not found, a 404 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Existing Opening

  • ID: delete_existing_opening
  • Operation: write
  • Entities: opening
  • Summary: This API endpoint allows the user to delete an existing opening by specifying the Opening ID in the path parameters. The request method is DELETE, and it requires the 'id' path parameter to identify the opening to be deleted. The request can include an 'accept' header to specify the desired response format, typically 'application/json'. If the deletion is successful, the API returns a 204 No Content response. If the request is unauthorized, a 401 Unauthorized response is returned with an error message. If the specified opening is not found, a 404 Not Found response is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Existing Position

  • ID: delete_existing_position
  • Operation: write
  • Entities: position
  • Summary: This API endpoint allows the user to delete an existing position by specifying the position ID in the path parameters. The request method is DELETE, and it requires the 'id' path parameter to identify the position to be deleted. The request can include an 'accept' header to specify the desired response format, though it is optional. The API returns a 204 status code with no content if the deletion is successful. If the request is unauthorized, a 401 status code is returned with a message indicating unauthorized access. If the specified position ID is not found, a 404 status code is returned with a message indicating that the position was not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Job

  • ID: delete_job
  • Operation: write
  • Entities: job, identifier
  • Summary: The Delete Job API allows users to delete a specific job using its unique identifier. The API requires the 'identifier' path parameter, which is a UUID representing the job to be deleted. The request does not require a body or additional query parameters. The response will return a JSON object containing metadata about the deletion operation, such as timestamp, HTTP method, path, and status. In case of an error, a detailed error message will be provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Location

  • ID: delete_location
  • Operation: write
  • Entities: location
  • Summary: The Delete Location API allows users to delete a specific location identified by a unique identifier. The API requires the 'identifier' path parameter, which is a UUID representing the location to be deleted. The request does not require a body or additional query parameters. The response will indicate the status of the deletion operation, wrapped in a JsonAPI root response. A successful operation returns a 200 status code with metadata, while a server error returns a 500 status code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Location Group

  • ID: delete_location_group
  • Operation: write
  • Entities: location group
  • Summary: The Delete Location Group API allows the user to delete a specific location group identified by a unique identifier. The API requires the 'identifier' path parameter, which is a UUID representing the location group to be deleted. The request does not require a body or additional query parameters. Upon successful deletion, the API returns a JSON response with metadata including the timestamp, HTTP method, path accessed, and status code. In case of an error, a detailed error message is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Location Groups

  • ID: delete_location_groups
  • Operation: write
  • Entities: location group
  • Summary: The Delete Location Groups API allows users to delete multiple location groups based on specified filtering criteria. The API uses the DELETE method and requires the 'accept' header to specify the response format, which is 'application/json'. The filtering criteria can be provided as query parameters. Upon successful deletion, the API returns metadata about the operation, including a timestamp, HTTP verb, path, request identifiers, count of affected items, status code, and duration. In case of an error, a detailed error message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Multiple EINs with Filtering

  • ID: delete_multiple_eins_with_filtering
  • Operation: write
  • Entities: service organization, ein
  • Summary: This API endpoint allows for the deletion of multiple EINs using specified filtering criteria. The DELETE method is used to perform the operation. The request can include query parameters to specify the filter criteria for selecting which EINs to delete. The response includes metadata about the operation, such as the timestamp, HTTP verb, API path, unique identifiers for the request and response, the number of items affected, the HTTP status code, and the duration of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Multiple Jobs with Filtering

  • ID: delete_multiple_jobs_with_filtering
  • Operation: write
  • Entities: job
  • Summary: This API endpoint allows the deletion of multiple jobs based on specified filter criteria. The DELETE method is used, and the endpoint is accessed via the URL https://wxp-services.fountain.com/api/serviceworkforce/jobs. The request can include query parameters for filtering the jobs to be deleted. The response includes metadata about the operation, such as the timestamp, HTTP verb, path, request ID, and status. In case of an error, a detailed error message is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Multiple Locations with Filtering

  • ID: delete_multiple_locations_with_filtering
  • Operation: write
  • Entities: location
  • Summary: This API endpoint allows the deletion of multiple locations using specified filtering criteria. The DELETE method is used at the endpoint https://wxp-services.fountain.com/api/serviceworkforce/locations. The request can include query parameters for filtering the locations to be deleted. The response will include metadata about the delete operation if successful, or an error message if unsuccessful. The 'accept' header can be used to specify the desired response format, typically 'application/json'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an Option Bank

  • ID: delete_option_bank
  • Operation: write
  • Entities: option bank
  • Summary: The 'Delete an Option Bank' API endpoint allows users to delete a specific option bank identified by its unique ID. The request requires the 'id' path parameter, which is mandatory. The request header can optionally include 'accept: application/json' to specify the desired response format. Upon successful deletion, the API returns a 204 status code with no content. If the request is unauthorized, a 401 status code is returned with an error object containing an error identifier. The API is accessed via the DELETE method at the endpoint 'https://api.fountain.com/v2/option_banks/{id}'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Remove an Option Bank Option

  • ID: delete_remove_option_bank_option
  • Operation: write
  • Entities: option bank
  • Summary: The 'Remove an Option Bank Option' API allows users to delete specific options from an option bank identified by its ID. The API requires the 'id' path parameter to specify the option bank and a 'options' query parameter to list the options to be removed. The request does not require a body. On success, it returns a 200 status with the updated option bank details. If unauthorized, it returns a 401 status with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Stored File

  • ID: delete_stored_file
  • Operation: write
  • Entities: stored file
  • Summary: The Delete Stored File API allows users to delete a stored file identified by a unique identifier. The API requires the 'identifier' path parameter, which is a UUID representing the stored file to be deleted. The request does not require a body or query parameters, and the 'accept' header is optional, defaulting to 'application/json'. Upon successful deletion, the API returns a 200 status code with metadata about the request, including timestamp, HTTP verb, request path, and duration. In case of an error, a 500 status code is returned with an error message detailing the issue.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Stored Files with Filtering

  • ID: delete_stored_files_with_filtering
  • Operation: write
  • Entities: file
  • Summary: This API endpoint allows users to delete multiple stored files by applying specific filtering criteria. The DELETE method is used, and the endpoint is accessed via the URL https://wxp-services.fountain.com/api/servicemedia/storedFiles. The request can include an optional 'filter' query parameter to specify the criteria for selecting files to delete. The response includes metadata about the operation, such as the timestamp, HTTP verb, path accessed, and status. In case of an error, a detailed error message is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Worker

  • ID: delete_worker
  • Operation: write
  • Entities: worker
  • Summary: The Delete Worker API allows the deletion of a worker identified by a unique identifier. The API uses the DELETE method and requires the 'identifier' path parameter, which is a UUID representing the worker to be deleted. The request should include an 'accept' header with 'application/json' as the value. The response returns a JSON object with metadata about the deletion operation, including a timestamp, HTTP verb, request path, and status code. In case of an error, a detailed error message is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Worker Custom Attribute

  • ID: delete_worker_custom_attribute
  • Operation: write
  • Entities: custom attribute, worker
  • Summary: The Delete Worker Custom Attribute API allows you to delete a custom attribute associated with a specific worker. It requires two path parameters: 'workerIdentifier', which is the unique identifier of the worker, and 'customAttributeIdentifier', which is the unique identifier of the custom attribute to be deleted. The API uses the DELETE method and does not require a request body. Upon successful deletion, it returns a 204 status code indicating that the worker's custom attribute has been successfully deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Workers with Filtering

  • ID: delete_workers_with_filtering
  • Operation: write
  • Entities: worker
  • Summary: This API endpoint allows for the deletion of multiple workers based on specified filtering criteria. The DELETE method is used, and the endpoint accepts query parameters to filter the workers to be deleted. The 'filter' query parameter is an object that can include 'where' conditions, 'limit' to specify the number of workers to delete, 'skip' to skip a number of workers, and 'order' to determine the order of deletion. The response includes metadata about the operation, such as the timestamp, HTTP verb, path accessed, and the number of workers affected.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Workflow in an Account

  • ID: delete_workflow_in_account
  • Operation: write
  • Entities: workflow, account
  • Summary: This API endpoint allows you to delete a workflow in an account by specifying the workflow's unique identifier in the path parameter. The request method is DELETE, and it requires an 'id' path parameter to identify the workflow to be deleted. The request header can optionally include 'accept: application/json' to specify the desired response format. If the deletion is successful, the API returns a 202 No Content response. If the request is unauthorized, a 401 Unauthorized response is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Access Applicant Notes

  • ID: get_access_applicant_notes
  • Operation: read
  • Entities: applicant, user, note
  • Summary: This API endpoint allows you to access notes associated with a specific applicant by their unique ID. The request requires the applicant's ID as a path parameter and the 'accept' header set to 'application/json'. The response includes an array of notes, each containing details such as the note's ID, content, creation and update timestamps, and information about the user who created and last updated the note.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Access Secure File Uploads from Fountain

  • ID: get_access_secure_file_uploads
  • Operation: read
  • Entities: applicant, file upload, secure document
  • Summary: This API endpoint allows access to secure file uploads from Fountain, such as driver's license photos and insurance documents. It requires enabling secure file access for your account. The endpoint returns a list of secure documents associated with an applicant, including details like document name, size, approval status, and a public URL valid for 24 hours. The 'id' path parameter is required to specify the applicant, and the response includes detailed information about each document and its associated stage and file upload requests.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Account Users

  • ID: get_all_account_users
  • Operation: read
  • Entities: user
  • Summary: This API endpoint retrieves all users associated with an account. It requires a GET request to the URL https://api.fountain.com/v2/users with the 'accept' header set to 'application/json'. The response will include a list of users, each with a name, id, and email. If the request is unauthorized, a 401 error will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find API Key by Unique Identifier

  • ID: get_api_key_by_unique_identifier
  • Operation: read
  • Entities: apikey
  • Summary: This API endpoint allows you to find an API key by its unique identifier. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/servicesecurity/apikeys/{identifier}', where 'identifier' is a required path parameter representing the unique identifier of the API key. The request header should include 'accept: application/json' to specify the desired response format. The response includes detailed information about the API key, such as its UUID, creation and update timestamps, key and secret values, label, audience type, and associated UUIDs for audience, company, and user. The response is wrapped in a JSON API root response with the document as data, and includes metadata about the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find API Keys with Filtering, Projection, Pagination, and Limiting

  • ID: get_api_keys_with_filtering_projection_pagination_limiting
  • Operation: read
  • Entities: apikey
  • Summary: This API endpoint allows users to find multiple API keys with options for filtering, projection, pagination, and limiting. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/servicesecurity/apikeys'. The API accepts query parameters for filtering, specifically a 'filter' object that can include a 'collate' object with a 'locale' property. The response returns a JSON object containing an array of API key documents under the 'data' property, each with details such as 'uuid', 'createdAt', 'key', 'secret', and more. Additionally, metadata about the request is provided under the 'meta' property, including 'timestamp', 'verb', 'path', 'count', and 'duration'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Applicant Data

  • ID: get_applicant_data
  • Operation: read
  • Entities: applicant, secure field, profile information
  • Summary: The 'Get Applicant Data' API endpoint retrieves all profile information for a specified applicant from Fountain. This is a standard GET request that requires the applicant's unique identifier as a path parameter. The endpoint returns a comprehensive JSON object containing various details about the applicant, including personal information, contact details, secure data, and other related information. Sensitive data such as Personally Identifiable Information (PII) is not retrieved by default. If access to secured fields is required, contact Fountain support. The response includes fields like email, name, phone number, secure data, and more, with detailed information about the applicant's background checks, document uploads, and other attributes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Applicant Labels

  • ID: get_applicant_labels
  • Operation: read
  • Entities: applicant, label
  • Summary: This API endpoint retrieves all labels associated with a specific applicant identified by the 'id' path parameter. The request requires the 'id' of the applicant as a path parameter and optionally accepts a header specifying the desired response format, typically 'application/json'. Additionally, the request headers must include 'Content-Type' set to 'application/json' and 'X-ACCESS-TOKEN' with your Fountain app's API token. The response will return a list of labels in a JSON object if the request is successful (HTTP 200). Each label object contains a 'title' and a 'completed' status. If the request is unauthorized, an error message will be returned (HTTP 401).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Applicant Transition History

  • ID: get_applicant_transition_history
  • Operation: read
  • Entities: applicant, stage, transition
  • Summary: This API endpoint retrieves the transition history for a specific applicant identified by the 'id' path parameter. It supports cursor pagination, allowing retrieval of up to 100 stage transitions per page. The request requires the 'id' path parameter and optionally accepts a 'page' query parameter for pagination. The response includes a list of transitions with details such as stage ID, title, and timestamps, along with pagination information. A 401 Unauthorized error is returned if the request is not properly authenticated.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Available Slots for a Given Stage

  • ID: get_available_slots_for_stage
  • Operation: read
  • Entities: slot, stage, pagination
  • Summary: This API endpoint lists all available slots for a given stage. It uses pagination to browse through all the slots, with the 'page' query parameter indicating the page number. The 'id' path parameter is required to specify the stage identifier. The response includes a list of slots with details such as 'id', 'start_time', 'end_time', 'location', 'recruiter', 'max_attendees', and 'booked_slots_count'. Pagination details are also provided in the response. The API returns a 200 status code with the slots data on success, a 401 status code if unauthorized, and a 404 status code if the stage is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Brand Details

  • ID: get_company_brand_details
  • Operation: read
  • Entities: brand, color, company
  • Summary: This API endpoint retrieves the brand details of a company identified by the 'companySlug' path parameter. The request is made using the GET method and requires the 'companySlug' as a path parameter. The response includes details such as the company's logo URL, website URL, color scheme, name, portal options, account slug, and career site base URL. The response is returned in JSON format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Company Details by Identifier

  • ID: get_company_details_by_identifier
  • Operation: read
  • Entities: address, brand, company
  • Summary: This API endpoint retrieves the details of a company using its unique identifier. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/serviceorganizations/companies/{identifier}', where '{identifier}' is a required path parameter representing the company's unique identifier in UUID format. The request header can optionally include 'accept: application/json' to specify the desired response format. The response includes a JSON object with detailed information about the company, such as its UUID, creation and update timestamps, name, brand details, address, welcome and help content, invitation messages, and various configuration options. The response also includes metadata about the request, such as the timestamp, HTTP verb, request path, and status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Count API Keys with Filtering, Pagination, and Limiting

  • ID: get_count_apikeys_with_filtering_pagination_limiting
  • Operation: read
  • Entities: apikey
  • Summary: This API endpoint is used to count the number of API keys with options for filtering, pagination, and limiting. It is accessed via a GET request to the specified URL. The request can include a query parameter 'filter' to specify filtering criteria. The response returns a JSON object containing the count of API key documents found, wrapped in a JsonAPI root response. The response includes metadata such as timestamp, HTTP verb, request path, JSON Web Token ID, request ID, count, status, and duration. In case of an error, a default error response is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Count Companies with Filtering, Pagination, and Limiting

  • ID: get_count_companies_with_filtering_pagination_and_limiting
  • Operation: read
  • Entities: service organization, company
  • Summary: This API endpoint is used to count the number of companies with options for filtering, pagination, and limiting. It is accessed via a GET request to the specified URL. The request can include query parameters for filtering the count of companies. The response includes a JSON object with the count of company documents found, wrapped in a JsonAPI root response. The response also includes metadata such as the timestamp, HTTP method, API path, and request duration. In case of an error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Count Custom Attributes with Filtering, Pagination, and Limiting

  • ID: get_count_custom_attributes
  • Operation: read
  • Entities: custom attribute
  • Summary: This API endpoint counts the number of custom attribute documents available, with options for filtering, pagination, and limiting the results. The request is made using the GET method to the specified URL. The API accepts an optional 'filter' query parameter to specify criteria for counting. The response returns a JSON object containing the count of custom attributes found, wrapped in a JsonAPI root response. The response body includes a 'data' object with the 'count' property indicating the number of documents. In case of an error, a default error response is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Count DataGroups with Filtering, Pagination, and Limiting

  • ID: get_count_datagroups_with_filtering_pagination_limiting
  • Operation: read
  • Entities: count, response, data group
  • Summary: This API endpoint is used to count dataGroups with options for filtering, pagination, and limiting. It is accessed via a GET request to the specified URL. The request can include query parameters for filtering the dataGroups. The response returns a JSON object containing the count of dataGroup documents found, along with metadata such as the timestamp, HTTP method, API path, and request duration. The response is wrapped in a JsonAPI root response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Count EINs with Filtering, Pagination, and Limiting

  • ID: get_count_eins_with_filtering_pagination_limiting
  • Operation: read
  • Entities: filter, service organization, ein
  • Summary: This API endpoint allows users to count EIN documents with optional filtering, pagination, and limiting. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/serviceorganizations/eins/count'. The API accepts an optional query parameter 'filter' for specifying filter criteria. The response returns a JSON object containing the count of EIN documents found, wrapped in a JsonAPI root response. The response includes metadata such as timestamp, HTTP method, API path, and request identifiers. In case of an error, a detailed error message is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Count Employers with Filtering, Pagination, and Limiting

  • ID: get_count_employers_with_filtering_pagination_and_limiting
  • Operation: read
  • Entities: count, filter, employer
  • Summary: This API endpoint counts the number of employer documents available, with options for filtering, pagination, and limiting. It uses the GET method and requires no request body. The endpoint accepts an optional 'filter' query parameter to specify criteria for counting employers. The response is a JSON object containing the count of employer documents found, wrapped in a JsonAPI root response. The response includes a 'data' object with the 'count' property and a 'meta' object for additional metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Count Jobs with Filtering, Pagination, and Limiting

  • ID: get_count_jobs_with_filtering_pagination_limiting
  • Operation: read
  • Entities: job
  • Summary: This API endpoint allows users to count job documents with options for filtering, pagination, and limiting. The request is made using the GET method to the specified URL. The API accepts an optional 'filter' query parameter to specify criteria for counting jobs. The response returns a JSON object containing the count of job documents found, wrapped in a JsonAPI root response. The response also includes metadata such as the timestamp, HTTP method, request path, and duration of the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Count Location Groups

  • ID: get_count_location_groups
  • Operation: read
  • Entities: parameter, response, location group
  • Summary: The Count Location Groups API endpoint allows users to count the number of location group documents available. It supports filtering through query parameters, and the response is wrapped in a JSON API root response. The API returns the count of location groups found, along with metadata such as timestamp, HTTP method, API path, request ID, and duration of the request. The response is provided in JSON format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Count Locations with Filtering, Pagination, and Limiting

  • ID: get_count_locations_with_filtering_pagination_and_limiting
  • Operation: read
  • Entities: location
  • Summary: This API endpoint counts the number of location documents available, with options for filtering, pagination, and limiting the results. The request is made using the GET method to the specified URL. The API accepts an optional 'filter' query parameter to specify criteria for counting locations. The response returns a JSON object containing the count of location documents found, wrapped in a JsonAPI root response. The response body includes a 'data' object with the 'count' property indicating the number of locations, and a 'meta' object for additional metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Count Open Signups

  • ID: get_count_open_signups
  • Operation: read
  • Entities: opensignup
  • Summary: The Count Open Signups API endpoint allows users to count the number of open signup documents with optional filtering. The request is made using the GET method to the specified URL. Users can include query parameters to filter the results. The response returns a JSON object containing the count of open signup documents found, wrapped in a JsonAPI root response. The response body includes a 'data' object with the 'count' property and a 'meta' object for additional metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Count SignDocs with Filtering, Pagination, and Limiting

  • ID: get_count_signdocs
  • Operation: read
  • Entities: signDoc
  • Summary: This API endpoint counts the number of signDoc documents available, with options for filtering, pagination, and limiting. It uses the GET method and requires no request body. The endpoint accepts an optional 'filter' query parameter to specify filtering criteria. The response returns a JSON object containing the count of signDoc documents found, wrapped in a JsonAPI root response. The response body includes a 'data' object with a 'count' property indicating the number of documents. In case of an error, a default error response is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Count Stored Files with Filtering, Pagination, and Limiting

  • ID: get_count_stored_files_with_filtering_pagination_and_limiting
  • Operation: read
  • Entities: stored file
  • Summary: This API endpoint counts the number of stored files with options for filtering, pagination, and limiting. It uses the GET method and requires no request body. The 'filter' query parameter can be used to specify criteria for counting. The response returns a JSON object containing the count of stored files in the 'data' field. The response is wrapped in a JsonAPI root response format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Count Workers with Filtering, Pagination, and Limiting

  • ID: get_count_workers_with_filtering_pagination_and_limiting
  • Operation: read
  • Entities: worker
  • Summary: This API endpoint counts the number of worker documents available, with options for filtering, pagination, and limiting the results. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/serviceworkforce/workers/count'. The API accepts query parameters under 'filter', which can include 'where' conditions, 'limit' for the number of records, 'skip' for pagination, and 'order' for sorting. The response returns a JSON object containing the count of workers found in the 'data' field, along with metadata such as timestamp, HTTP method, path, request ID, and duration in the 'meta' field.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Custom Attribute by Identifier

  • ID: get_custom_attribute_by_identifier
  • Operation: read
  • Entities: custom attribute
  • Summary: This API endpoint retrieves a custom attribute by its unique identifier. The request requires the 'identifier' path parameter, which is a UUID representing the custom attribute's unique identifier. The response returns a JSON object containing the custom attribute details, including its UUID, creation and update timestamps, label, key, data type, description, options, resource, and various flags indicating its properties such as read-only, hidden, and protected status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find Custom Attributes with Filtering, Projection, Pagination, and Limiting

  • ID: get_custom_attributes_with_filtering_projection_pagination_limiting
  • Operation: read
  • Entities: custom attribute, document, service workforce
  • Summary: This API endpoint allows users to find multiple custom attributes with options for filtering, projection, pagination, and limiting. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/serviceworkforce/customAttributes'. The API accepts query parameters for filtering, specifically a 'filter' object that can include a 'collate' object with a 'locale' property. The response returns a JSON object containing an array of custom attribute documents, each with properties such as 'uuid', 'createdAt', 'label', 'key', 'dataType', and more. The response also includes metadata about the request, such as 'timestamp', 'verb', 'path', 'status', and 'duration'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Custom Export Templates

  • ID: get_custom_export_templates
  • Operation: read
  • Entities: pagination, template
  • Summary: This API endpoint retrieves a list of all custom export templates available in the system. It uses the GET method and requires no request body or query parameters. The response includes a list of templates, each with an ID, title, fields, and associated funnel IDs. Additionally, pagination information is provided to navigate through the list of templates. The response is returned in JSON format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get DataGroup by Identifier

  • ID: get_datagroup_by_identifier
  • Operation: read
  • Entities: identifier, data group, company
  • Summary: This API endpoint retrieves a dataGroup by its unique identifier. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/servicestaff/dataGroups/{identifier}', where 'identifier' is a required path parameter representing the dataGroup's unique identifier in UUID format. The response returns a JSON object containing the dataGroup details such as 'uuid', 'createdAt', 'createdBy', 'lastUpdatedAt', 'lastUpdatedBy', 'label', and 'lookerGroupId'. Additionally, metadata about the request is provided, including 'timestamp', 'verb', 'path', 'jti', 'rid', 'count', 'status', and 'duration'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find DataGroups with Filtering, Projection, Pagination, and Limiting

  • ID: get_datagroups_with_filtering_projection_pagination_limiting
  • Operation: read
  • Entities: data group
  • Summary: This API endpoint allows users to find multiple dataGroups with options for filtering, projection, pagination, and limiting. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/servicestaff/dataGroups'. The API accepts query parameters for filtering, such as 'filter[collate][locale]', which can be used to specify the locale for collation. The response is a JSON object that includes an array of dataGroup documents and metadata. The response schema includes a 'data' array and a 'meta' object, but no specific example of the response body is provided in the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get details of a specific job

  • ID: get_details_of_a_specific_job
  • Operation: read
  • Entities:
  • Summary: This API endpoint allows users to find a specific opening by its unique identifier. The request requires the 'id' path parameter, which is the unique Job ID. The request headers must include 'Content-Type' set to 'application/json' and 'X-ACCESS-TOKEN' which is your fountain app's API token. The response includes detailed information about the opening, such as title, description, apply URL, address, time zone, requirements, and more. The response also includes nested objects like opening pay rate, stages, fields, location, owner, position, and shift details. If the request is unauthorized, a 401 error is returned, and if the opening is not found, a 404 error is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Download Custom Export

  • ID: get_download_custom_export
  • Operation: read
  • Entities: export, template
  • Summary: The 'Download Custom Export' API allows users to download a custom export file that has been previously created. The API requires the 'id' of the export as a path parameter to identify which export to download. The response includes details such as the export's ID, creation and update timestamps, status, file URL, and associated template information. The file URL will return a 404 error until the export is finished processing, and it will expire one week after creation. Users can poll this endpoint to check the status of the export until it is ready for download.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Download Timestamped Export

  • ID: get_download_timestamped_export
  • Operation: read
  • Entities: export, file, template
  • Summary: The 'Download Timestamped Export' API allows users to download an export file that has been created, specified by its unique identifier 'id'. The endpoint is accessed via a GET request to 'https://api.fountain.com/v2/timestamped_exports/{id}'. The 'id' is a required path parameter that identifies the specific export to download. The response includes details such as the export's 'id', 'created_at' and 'updated_at' timestamps, 'state', 'file_url', and associated 'template' information. The 'file_url' will return a 404 error until the export state is 'finished', and it expires one week from creation. Users may need to poll the endpoint until the file is ready. The API returns a 200 status code with the export details on success, or a 401 status code if unauthorized.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find EIN by Unique Identifier

  • ID: get_ein_by_unique_identifier
  • Operation: read
  • Entities: ein, service organization, company
  • Summary: This API endpoint allows users to find an EIN (Employer Identification Number) by its unique identifier. The request requires a path parameter 'identifier' which is a UUID representing the EIN's unique identifier. The response returns a JSON object containing the EIN details such as uuid, createdAt, createdBy, lastUpdatedAt, lastUpdatedBy, label, ein, hireBrandIds, and isDefault. The response is wrapped in a JsonAPI root response with the document as data. The meta section of the response includes additional information such as timestamp, HTTP verb, path, JSON Token Identifier (jti), Request Identifier (rid), count of items returned, status, and duration of the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find EINs with Filtering, Projection, Pagination, and Limiting

  • ID: get_eins_with_filtering_projection_pagination_limiting
  • Operation: read
  • Entities: service organization, ein
  • Summary: This API endpoint allows users to find multiple EINs with options for filtering, projection, pagination, and limiting. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/serviceorganizations/eins'. The API accepts query parameters for filtering, such as 'filter[collate][locale]', which can be used to specify the locale for collation. The response returns a JSON object containing an array of EIN documents under the 'data' key, each with properties like 'uuid', 'createdAt', 'createdBy', 'lastUpdatedAt', 'lastUpdatedBy', 'label', 'ein', 'hireBrandIds', and 'isDefault'. Additionally, metadata about the request is provided under the 'meta' key, including 'timestamp', 'verb', 'path', 'jti', 'rid', 'count', 'status', and 'duration'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Employer by Identifier

  • ID: get_employer_by_identifier
  • Operation: read
  • Entities: location, employer, company
  • Summary: This API endpoint retrieves the details of a specific employer using their unique identifier. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/servicestaff/employers/{identifier}', where '{identifier}' is a required path parameter representing the employer's unique identifier in UUID format. The request header should include 'accept: application/json' to specify the response format. The response returns a JSON object containing detailed information about the employer, including their UUID, creation and update timestamps, company details, personal information such as name and email, location details, and other metadata. The response is structured in a JSON API format with the employer data encapsulated within a 'data' object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find Employers with Filtering, Projection, Pagination, and Limiting

  • ID: get_employers_with_filtering_projection_pagination_limiting
  • Operation: read
  • Entities: employer
  • Summary: This API endpoint allows users to find multiple employers with options for filtering, projection, pagination, and limiting. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/servicestaff/employers'. The API accepts query parameters for filtering, such as 'filter[collate][locale]' to specify locale settings. The response returns a JSON object containing an array of employer documents under the 'data' key and additional metadata under the 'meta' key. The response is wrapped in a JsonAPI root response. If no employers are found or an error occurs, an error message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find Companies with Filtering, Projection, Pagination, and Limiting

  • ID: get_find_companies_with_filtering_projection_pagination_and_limiting
  • Operation: read
  • Entities: address, brand, company
  • Summary: This API endpoint allows users to find multiple companies with options for filtering, projection, pagination, and limiting. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/serviceorganizations/companies'. The API accepts query parameters for filtering, such as 'filter[collate][locale]', which can be used to specify the locale for collation. The response includes a collection of company documents wrapped in a JsonAPI root response. Each company document contains detailed information such as UUID, creation and update timestamps, name, brand details, address, welcome and help content, invitation messages, portal setup status, metadata, legal name, EIN, hire account details, support contact information, messaging options, and analytics options. The response also includes metadata about the request, such as timestamp, HTTP verb, request path, JSON Token Identifier (jti), Request Identifier (rid), count of items, status code, and request duration.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find Jobs with Filtering, Projection, Pagination, and Limiting

  • ID: get_find_jobs_with_filtering_projection_pagination_and_limiting
  • Operation: read
  • Entities: job
  • Summary: This API endpoint allows users to find multiple job documents with options for filtering, projection, pagination, and limiting. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/serviceworkforce/jobs'. The API supports query parameters for filtering, such as 'filter[collate][locale]' to specify the locale for collation. The response returns a collection of job documents wrapped in a JSON API root response. The response body includes 'data', which is an array of job documents, and 'meta', which contains metadata about the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find Locations with Filtering, Projection, Pagination, and Limiting

  • ID: get_find_locations_with_filtering_projection_pagination_and_limiting
  • Operation: read
  • Entities: location
  • Summary: This API endpoint allows users to find multiple locations with options for filtering, projection, pagination, and limiting. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/serviceworkforce/locations'. The API accepts query parameters for filtering, such as 'filter[collate][locale]', which can be used to specify the locale for collating the results. The response returns one or many location documents wrapped in a JsonAPI root response with a collection of documents as data. The response schema includes an array of location documents and metadata about the response. In case of an error, a default error response is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find Open Signups with Filtering, Projection, Pagination, and Limiting

  • ID: get_find_open_signups
  • Operation: read
  • Entities: document, service security, opensignup
  • Summary: This API endpoint allows users to find multiple open signups with options for filtering, projection, pagination, and limiting. The request is made using the GET method to the specified URL. The query parameters include a 'filter' object that can be used to specify collation options such as locale. The response returns a JSON object containing an array of open signup documents under the 'data' key and additional metadata under the 'meta' key. If no response example is available, an error message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find SignDoc by Identifier

  • ID: get_find_signdoc_by_identifier
  • Operation: read
  • Entities: document, sign doc, company
  • Summary: This API endpoint allows you to find a signDoc by its unique identifier. The request is made using the GET method to the URL https://wxp-services.fountain.com/api/servicemedia/signDocs/{identifier}, where {identifier} is the unique identifier of the signDoc. The request requires an 'accept' header with the value 'application/json'. The response returns a JSON object containing the signDoc details, including its UUID, creation and update timestamps, creator and updater UUIDs, name, technical name, file URLs, merge keys, template ID, edit embed URL, company UUID, and flags for technical and counter-sign enabled status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find SignDocs with Filtering, Projection, Pagination, and Limiting

  • ID: get_find_signdocs_with_filtering_projection_pagination_and_limiting
  • Operation: read
  • Entities: document, signDoc
  • Summary: This API endpoint allows users to find multiple signDoc documents with options for filtering, projection, pagination, and limiting. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/servicemedia/signDocs'. The API accepts query parameters for filtering, such as 'filter[collate][locale]=en', and the response is expected to be in JSON format. The response includes a collection of signDoc documents wrapped in a JsonAPI root response. The API returns a 200 status code with the documents found or a 500 status code for a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find Workers with Filtering, Projection, Pagination, and Limiting

  • ID: get_find_workers_with_filtering_projection_pagination_limiting
  • Operation: read
  • Entities: job, worker, company
  • Summary: This API endpoint allows you to find multiple workers with options for filtering, projection, pagination, and limiting. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/serviceworkforce/workers'. You can specify query parameters such as 'filter' to apply conditions, select fields, limit the number of results, skip a number of results, and order the results. The response returns an array of worker documents along with metadata about the request. The response includes detailed information about each worker, such as personal details, contact information, job details, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Generate Signed Stored File URL

  • ID: get_generate_signed_stored_file_url
  • Operation: read
  • Entities: url, file, company
  • Summary: This API endpoint generates a signed URL to access a stored file. It requires two path parameters: 'companyIdentifier' and 'storedFileIdentifier', both of which are UUIDs and are required. The request should include an 'accept' header with the value 'application/json'. The response will include a '200' status with a JSON object containing the signed URL under 'data.url' and metadata under 'meta'. If the file is not found, a '404' error response will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Impersonate Worker in Portal

  • ID: get_impersonate_worker_in_portal
  • Operation: read
  • Entities: worker, user
  • Summary: This API allows impersonating a worker in their own portal by generating a login link with an authentication token. The API requires a GET request to the specified endpoint with the worker's UUID as a path parameter. The response includes a JSON object containing the login link and metadata about the request such as timestamp, HTTP verb, path, and status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Interview Sessions for an Applicant

  • ID: get_interview_sessions_for_an_applicant
  • Operation: read
  • Entities: applicant, interview, booked slot
  • Summary: This API endpoint retrieves the interview sessions for a specific applicant identified by their unique ID. The request requires the applicant's ID as a path parameter and optionally accepts a header specifying the desired response format (e.g., application/json). The response includes a list of booked interview slots with details such as start and end times, location, recruiter, and other relevant information. If the request is unauthorized, a 401 error message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find Job by Unique Identifier

  • ID: get_job_by_unique_identifier
  • Operation: read
  • Entities: job
  • Summary: This API endpoint allows users to find a job by its unique identifier. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/serviceworkforce/jobs/{identifier}', where 'identifier' is a required path parameter representing the job's unique identifier in UUID format. The request header can optionally include 'accept: application/json' to specify the desired response format. The response includes a JSON object with the job's details such as 'uuid', 'createdAt', 'createdBy', 'lastUpdatedAt', 'lastUpdatedBy', 'name', and 'description'. Additionally, metadata about the request is provided, including 'timestamp', 'verb', 'path', 'jti', 'rid', 'count', 'status', and 'duration'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Latest Matching Applicant

  • ID: get_latest_matching_applicant
  • Operation: read
  • Entities: applicant, brand, document
  • Summary: The 'Get Latest Matching Applicant' API endpoint retrieves the most recent applicant that matches the specified criteria. It is accessed via a GET request to the URL 'https://api.fountain.com/v2/applicants/latest_applicant'. The API accepts query parameters such as 'email', 'phone_number', and 'brand_id' to filter the applicants. The request must include an 'accept' header with the value 'application/json'. The response includes detailed information about the applicant, such as their email, name, phone number, and various other personal and application-related details. The response is returned in JSON format and includes a comprehensive set of fields that describe the applicant's profile, secure data, background checks, document uploads, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Applicants

  • ID: get_list_all_applicants
  • Operation: read
  • Entities: applicant, stage, funnel
  • Summary: The List All Applicants API endpoint allows users to retrieve a list of all applicants within their account. It supports pagination through both page numbers and cursor-based pagination. Users can filter applicants by various criteria such as funnel ID, stage ID, stage type, labels, creation date, last transition date, and more. The response includes detailed information about each applicant, including personal details, labels, background checks, and more. The API returns a JSON object containing the list of applicants and pagination details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Data Keys

  • ID: get_list_all_data_keys
  • Operation: read
  • Entities: data key
  • Summary: This API endpoint retrieves a list of all data keys associated with the account. It supports pagination through the 'page' and 'per_page' query parameters, allowing users to specify which page of results to retrieve and how many results per page. Additionally, the 'updated_at' query parameter can be used to filter data keys based on their last updated timestamp. The response includes an array of data keys, each with properties such as 'key', 'key_type', 'title', 'hidden', 'restricted', 'data_fields_count', and 'options'. The API returns a JSON response with the data keys and their details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Locations

  • ID: get_list_all_locations
  • Operation: read
  • Entities: location group, location, account
  • Summary: The 'List All Locations' API endpoint allows users to retrieve a list of all locations associated with their account. The request is made using the GET method to the URL 'https://api.fountain.com/v2/locations'. The request does not require any parameters or body content, but it can include an 'accept' header to specify the desired response format, typically 'application/json'. The response includes a list of location objects, each containing details such as 'account_id', 'id', 'created_at', 'address', 'street_address', 'city', 'state_code', 'postal_code', 'country_code', 'location_group', and 'name'. The 'location_group' itself is an object with 'id', 'name', and 'owner'. Additionally, the response includes pagination information with fields like 'first', 'last', 'previous', 'current', and 'next'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Openings in Account

  • ID: get_list_all_openings_in_account
  • Operation: read
  • Entities: opening, stage, funnel
  • Summary: This API endpoint retrieves a list of all openings (funnels) within your account. The term 'funnel' is used interchangeably with 'opening'. Each opening contains detailed information such as address, stages in the funnel, location, active status, and more. The API supports various query parameters to filter and sort the results, including pagination options, sorting by specific fields, and filtering by attributes like active status, brand name, location, shift details, and more. The response includes an array of funnel objects, each with comprehensive details about the opening, and pagination information to navigate through the results.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Positions

  • ID: get_list_all_positions
  • Operation: read
  • Entities: position, account, pagination
  • Summary: This API endpoint retrieves a list of all positions within your account. It requires a GET request to the URL https://api.fountain.com/v2/positions with an 'accept' header set to 'application/json'. The response includes an array of positions, each with an 'account_id', 'id', and 'name'. Additionally, pagination details are provided in the response to navigate through the list of positions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Roles for the Account

  • ID: get_list_all_roles_for_the_account
  • Operation: read
  • Entities: role
  • Summary: This API endpoint retrieves a list of all roles associated with the account. It uses the GET method and requires no request body or query parameters. The request should include an 'accept' header specifying 'application/json' as the acceptable media type for the response. The response will contain a JSON object with a 'roles' array, where each role object includes a 'name' and an 'id'. If the request is unauthorized, a 401 status code will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Sessions

  • ID: get_list_all_sessions
  • Operation: read
  • Entities: session, stage, slot
  • Summary: The List All Sessions API endpoint allows users to retrieve all booked slots for an account, with the option to include unbooked slots. It supports filtering based on opening (funnel_id) and stage (stage_id), and provides pagination options. The endpoint returns detailed information about each session, including start and end times, maximum attendees, and booked applicants' attendance status. Pagination can be managed using the page parameter or cursor-based pagination for accessing older pages. The response includes session details and pagination information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Shifts

  • ID: get_list_all_shifts
  • Operation: read
  • Entities: shift
  • Summary: The 'List All Shifts' API endpoint allows users to retrieve a list of all shifts associated with their account. This endpoint supports pagination through the 'page' and 'per_page' query parameters, which are both optional. The 'page' parameter specifies the page of results to retrieve, while the 'per_page' parameter specifies the number of results per page, defaulting to 20 if not provided. The response includes an array of shifts, each with a unique identifier. The API returns a 200 status code for successful requests and a 401 status code for unauthorized access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Timestamped Export Templates

  • ID: get_list_all_timestamped_export_templates
  • Operation: read
  • Entities: funnel id, timestamped export template, pagination
  • Summary: This API endpoint allows users to list all timestamped export templates available in the system. It is a GET request to the URL https://api.fountain.com/v2/timestamped_exports/templates. The request requires an 'accept' header with the value 'application/json'. The response includes a list of templates, each with details such as id, title, data keys, upper and lower bounds, busy status, type, number of days, and funnel IDs. The response also includes pagination information. If the request is unauthorized, a 401 error is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Workflows in an Account

  • ID: get_list_all_workflows_in_an_account
  • Operation: read
  • Entities: workflow, account
  • Summary: This API endpoint retrieves a list of all workflows in an account. It requires an 'accept' header with the value 'application/json'. The response includes a list of workflows with details such as country code, id, locale, openings count, title, creation date, and publication status. Pagination details are also provided. A 401 error indicates unauthorized access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Custom Export Templates

  • ID: get_list_custom_export_templates
  • Operation: read
  • Entities: opening, custom export, template
  • Summary: The 'List Custom Export Templates' API endpoint allows users to retrieve all custom export templates available in their account. This API uses the GET method and does not require any path parameters, query parameters, or request body. The request should include an 'accept' header with the value 'application/json'. The response includes a list of export templates, each with details such as 'id', 'created_at', 'updated_at', 'status', 'file_url', and associated 'template' information. Additionally, pagination details are provided to navigate through the list of exports.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Hiring Goals

  • ID: get_list_hiring_goals
  • Operation: read
  • Entities: hiring goal, pagination
  • Summary: The List Hiring Goals API endpoint allows users to retrieve a list of all hiring goals within their account. The API supports various query parameters to filter and sort the results, such as filtering by opening ID, status, and date ranges. The response includes an array of hiring goals, each with details like external ID, goal, hire-by date, and status. Pagination information is also provided to navigate through the results.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Labels in a Specific Stage

  • ID: get_list_labels_in_a_specific_stage
  • Operation: read
  • Entities: label, stage, funnel
  • Summary: This API endpoint retrieves a list of all labels available in a specific stage identified by the 'stage_id' path parameter. The request can optionally include a 'funnel_id' query parameter to filter the labels. The response will be a JSON object containing an array of labels if the request is successful (HTTP 200). If the request is unauthorized, an error message will be returned (HTTP 401).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Location Groups

  • ID: get_list_location_groups
  • Operation: read
  • Entities: location group, account, pagination
  • Summary: The 'List Location Groups' API endpoint allows users to retrieve all location groups associated with their account. It is a GET request to the URL 'https://api.fountain.com/v2/location_groups'. The request does not require any parameters or body content, but it can include an 'accept' header to specify the desired response format, typically 'application/json'. The response includes a list of location groups, each with an 'account_id', 'id', and 'name'. Additionally, pagination details are provided to navigate through the list of location groups.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Workers

  • ID: get_list_workers
  • Operation: read
  • Entities: worker, account, funnel
  • Summary: The List Workers API endpoint allows you to retrieve a list of all workers within your account. It supports pagination through the 'page' query parameter, enabling you to navigate through pages of workers. Additionally, you can filter the workers by a specific funnel using the 'funnel_id' parameter or by their active status using the 'is_active' parameter. The response includes an array of workers and pagination details. The request requires an 'accept' header with the value 'application/json'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Location by Identifier

  • ID: get_location_by_identifier
  • Operation: read
  • Entities: location, external location, company
  • Summary: This API endpoint retrieves a location by its unique identifier. The request requires a path parameter 'identifier' which is a UUID representing the location's unique identifier. The response returns a JSON object containing detailed information about the location, including its UUID, creation and update timestamps, name, description, address details, timezone, language, and any external location metadata. The response is wrapped in a JSON API root response with the location document as data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Location Details by ID

  • ID: get_location_details_by_id
  • Operation: read
  • Entities: opening, location group, location
  • Summary: This API endpoint allows you to retrieve details of a specific location using its unique identifier. The request requires the 'id' path parameter, which is the Location ID. The response includes detailed information about the location such as account ID, address, country code, language, location group details, name, owner, openings count, and more. The response can return a 200 status code with location details, a 401 status code for unauthorized access, or a 404 status code if the location is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Location Group by ID

  • ID: get_location_group_by_id
  • Operation: read
  • Entities: location group, customer attribute, location
  • Summary: This API endpoint retrieves a specific Location Group by its unique identifier. The request requires the 'id' path parameter, which is the Location Group ID. The response includes details such as the account ID, name, owner, and associated locations and customer attributes. The API returns a 200 status code with the location group details if successful, a 401 status code if unauthorized, and a 404 status code if the location group is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Location Group by Identifier

  • ID: get_location_group_by_identifier
  • Operation: read
  • Entities: virtual location, location group, company
  • Summary: This API endpoint retrieves a location group by its unique identifier. The request requires a path parameter 'identifier' which is a UUID representing the location group. The response returns a JSON object containing details about the location group, including its UUID, creation and update timestamps, creator and updater UUIDs, name, description, associated company UUID, location UUIDs, and virtual locations. The response is wrapped in a JsonAPI root response with the document as data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find Location Groups with Filtering, Projection, Pagination, and Limiting

  • ID: get_location_groups_with_filtering_projection_pagination_limiting
  • Operation: read
  • Entities: location group
  • Summary: This API endpoint allows users to find multiple location groups with options for filtering, projection, pagination, and limiting. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/serviceworkforce/locationGroups'. The API accepts query parameters for filtering, specifically a 'filter' object that can include a 'collate' object with a 'locale' property. The response returns a JSON object containing an array of location group documents and metadata. In case of an error, an error message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Opening Stages

  • ID: get_opening_stages
  • Operation: read
  • Entities: opening, stage, funnel
  • Summary: The 'Retrieve Opening Stages' API endpoint allows users to retrieve the stages of a specific opening by providing the 'funnel_id' as a path parameter. The request is made using the GET method to the URL 'https://api.fountain.com/v2/funnels/{funnel_id}/stages'. The request headers must include 'Content-Type: application/json' and 'X-ACCESS-TOKEN' with your Fountain app's API token. Optionally, the 'accept' header can specify 'application/json' to indicate the desired response format. The response includes a list of stages, each with details such as title, type, parent_id, id, and data fields. The data fields may contain options with values and labels. The API returns a 200 status code with the stages data on success, a 401 status code if unauthorized, and a 404 status code if the opening is not found.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get OpenSignup by Identifier

  • ID: get_opensignup_by_identifier
  • Operation: read
  • Entities: opensignup, virtual company, company
  • Summary: This API endpoint retrieves an opensignup document by its unique identifier. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/servicesecurity/opensignups/{identifier}', where 'identifier' is a required path parameter representing the unique identifier of the opensignup. The request header can optionally include 'accept: application/json' to specify the desired response format. The response includes a JSON object with the opensignup details, such as 'uuid', 'createdAt', 'createdBy', 'lastUpdatedAt', 'lastUpdatedBy', 'companyUuid', 'virtualCompany', 'enabled', 'code', and 'allowedDomains'. The response is wrapped in a JsonAPI root response with the document as data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Option Banks

  • ID: get_option_banks
  • Operation: read
  • Entities: option bank
  • Summary: The Get Option Banks API endpoint retrieves a list of option banks. It supports pagination through optional query parameters 'page' and 'per_page'. The 'page' parameter is an optional integer indicating the page number, and 'per_page' is an optional integer defining the number of items per page. The API returns a 200 OK response on success or a 401 Unauthorized response if the request is not authorized. No specific response example is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Show an Option Bank

  • ID: get_show_an_option_bank
  • Operation: read
  • Entities: option bank
  • Summary: This API endpoint retrieves the details of a specific option bank identified by its unique ID. The request requires the 'id' path parameter to specify which option bank to retrieve. The response includes the option bank's ID, name, and a list of options, each with a label, value, and a boolean indicating if it is the default option. If the request is unauthorized, a 401 error with an error message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find Specific Opening by ID

  • ID: get_specific_opening_by_id
  • Operation: read
  • Entities: opening, stage, location
  • Summary: This API endpoint allows users to find a specific opening by its unique identifier. The request requires the 'id' path parameter, which is the unique Job ID. The request headers must include 'Content-Type' set to 'application/json' and 'X-ACCESS-TOKEN' which is your fountain app's API token. The response includes detailed information about the opening, such as title, description, apply URL, address, time zone, requirements, and more. The response also includes nested objects like opening pay rate, stages, fields, location, owner, position, and shift details. If the request is unauthorized, a 401 error is returned, and if the opening is not found, a 404 error is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Specific Position by ID

  • ID: get_specific_position_by_id
  • Operation: read
  • Entities: position
  • Summary: This API endpoint allows you to find a specific Position by its unique identifier. The request requires the 'id' path parameter, which is the Position ID. The request should include an 'accept' header with the value 'application/json'. The response can be a successful 200 OK with a JSON object, a 401 Unauthorized, or a 404 Not Found, each with a unique identifier in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Specific Stage

  • ID: get_specific_stage
  • Operation: read
  • Entities: stage
  • Summary: This API endpoint retrieves a specific stage from the Fountain API. It requires the 'id' path parameter, which is the unique identifier of the stage to be retrieved. The request must include an 'accept' header specifying 'application/json' as the acceptable response format. The response will include details about the stage such as its 'id', 'title', 'type', 'parent_id', 'position', and 'num_applicants'. If the request is unauthorized, a 401 error will be returned. If the stage is not found, a 404 error will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Stored File by Identifier

  • ID: get_stored_file_by_identifier
  • Operation: read
  • Entities: stored file, metadata, identifier
  • Summary: This API endpoint retrieves a stored file by its unique identifier. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/servicemedia/storedFiles/{identifier}', where 'identifier' is a required path parameter representing the stored file's unique identifier in UUID format. The request header can optionally include 'accept: application/json' to specify the desired response format. The response includes a JSON object with detailed information about the stored file, such as its UUID, creation and update timestamps, name, storage location, and metadata including size, MIME type, and file type. The response also includes metadata about the request, such as the timestamp, HTTP verb, request path, and status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find Stored Files with Filtering, Projection, Pagination, and Limiting

  • ID: get_stored_files_with_filtering_projection_pagination_limiting
  • Operation: read
  • Entities: metadata, file, storage
  • Summary: This API endpoint allows users to find multiple stored files with options for filtering, projection, pagination, and limiting. The request is made using the GET method to the URL 'https://wxp-services.fountain.com/api/servicemedia/storedFiles'. The API accepts query parameters for filtering, such as 'filter[collate][locale]', which can be used to specify the locale for collation. The response includes a collection of stored file documents wrapped in a JSON API root response. Each stored file document contains details such as UUID, creation and update timestamps, file name, storage location, and metadata. The response also includes meta information about the request, such as the timestamp, HTTP verb, path, request ID, and duration.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Timestamped Export Templates

  • ID: get_timestamped_export_templates
  • Operation: read
  • Entities: timestamped export, pagination, template
  • Summary: The List Timestamped Export Templates API endpoint allows users to retrieve all timestamped export templates available in their account. The API uses the GET method and does not require any parameters or request body. The response includes a list of timestamped exports, each with details such as id, creation and update timestamps, state, file URL, and associated template information. Pagination details are also provided in the response to navigate through the list of exports.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve User Activities

  • ID: get_user_activities
  • Operation: read
  • Entities: applicant, activity, user
  • Summary: This API endpoint retrieves all activities of a specific user. It requires the user ID as a path parameter and allows filtering by date range and activity type through query parameters. The maximum date range allowed is one month. The response includes a list of activities with details such as activity type, owner ID, applicant ID, and timestamps. The endpoint supports pagination with 'per_page' and 'page' query parameters.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get User Opening Access

  • ID: get_user_opening_access
  • Operation: read
  • Entities: workflow permission, funnel permission, user
  • Summary: The Get User Opening Access API retrieves the access permissions for a specific user identified by the user_id path parameter. The API returns details about the user's funnel permissions, workflow permissions, and whether the user is a funnels admin. The request requires the user_id as a path parameter and accepts an optional 'accept' header to specify the response format. The response includes arrays of funnel and workflow permissions, each with specific IDs and access details, and a boolean indicating if the user has admin access to funnels.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find Worker by Unique Identifier

  • ID: get_worker_by_unique_identifier
  • Operation: read
  • Entities: job, worker, company
  • Summary: This API endpoint retrieves a worker's details using their unique identifier. The request requires the 'identifier' path parameter, which is a UUID representing the worker's unique ID. The request must include an 'accept' header with the value 'application/json'. The response returns a JSON object containing detailed information about the worker, including personal details, contact information, employment status, and associated metadata. The response is wrapped in a JSON API root response with the worker document as data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Worker Info

  • ID: get_worker_info
  • Operation: read
  • Entities: worker, secure field, data collection check
  • Summary: The Get Worker Info API endpoint retrieves basic worker data, status, and the last data collection checks collected and approved in posthire. It requires the worker ID (same as applicant ID) as a path parameter. The response includes the worker's information, but data collected via a secure field will not be available unless specifically requested. To access secure data, contact Fountain support for a secure-fields specific API key. The API returns a JSON object with worker details or error messages for unauthorized or not found responses.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all jobs

  • ID: list_all_jobs
  • Operation: read
  • Entities:
  • Summary: This API endpoint retrieves a list of all openings (funnels) within your account. The term 'funnel' is used interchangeably with 'opening'. Each opening contains detailed information such as address, stages in the funnel, location, active status, and more. The API supports various query parameters to filter and sort the results, including pagination options, sorting by specific fields, and filtering by attributes like active status, brand name, location, shift details, and more. The response includes an array of funnel objects, each with comprehensive details about the opening, and pagination information to navigate through the results.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Existing DataGroup

  • ID: patch_existing_datagroup
  • Operation: write
  • Entities: data group
  • Summary: This API endpoint allows for the partial update of an existing dataGroup identified by a unique identifier. The request is made using the PATCH method to the URL https://wxp-services.fountain.com/api/servicestaff/dataGroups/{identifier}. The identifier is a required path parameter and must be a valid UUID. The request headers should include 'accept' and 'content-type' set to 'application/json'. The request body should contain the partial dataGroup object with the required 'py/id' property. Upon successful update, the API returns a 202 response with the updated dataGroup object and metadata in the response body. In case of an error, a 500 response is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Existing Location Group

  • ID: patch_existing_location_group
  • Operation: write
  • Entities: location group
  • Summary: This API endpoint allows for the partial update of an existing location group identified by a unique identifier. The request is made using the PATCH method to the specified URL with the identifier as a path parameter. The request headers should include 'accept' and 'content-type' set to 'application/json'. The request body should contain the 'locationGroup' object that needs to be updated. The response will include the updated location group data wrapped in a JSON API root response. If successful, a 202 status code is returned. In case of an error, a 500 status code is returned with a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Existing Worker

  • ID: patch_existing_worker
  • Operation: write
  • Entities: job, worker, location
  • Summary: This API endpoint allows for the partial update of an existing worker's details. The PATCH request is made to the URL 'https://wxp-services.fountain.com/api/serviceworkforce/workers/{identifier}', where 'identifier' is a required path parameter representing the unique identifier of the worker. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body can include fields such as 'segmentEnabled', 'messagingEnabled', 'ssoEnabled', 'isTestWorker', 'importUpdatesLocked', and 'technicalOptions' to specify the updates. The response returns a JSON object containing the updated worker details, including personal information, employment status, and technical options. The response also includes metadata about the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update an Existing Opensignup

  • ID: patch_partially_update_an_existing_opensignup
  • Operation: write
  • Entities: domain, opensignup, company
  • Summary: This API endpoint allows for the partial update of an existing opensignup identified by a unique identifier. The PATCH method is used to update the 'enabled' status of the opensignup. The request requires headers specifying 'accept' and 'content-type' as 'application/json'. The path parameter 'identifier' is mandatory and must be a valid UUID. The request body must include the 'enabled' field as a boolean. On success, the API returns a 202 response with the updated opensignup details wrapped in a JsonAPI root response. In case of an error, a 500 response with an error message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Custom Attribute

  • ID: patch_partially_update_custom_attribute
  • Operation: write
  • Entities: custom attribute
  • Summary: This API endpoint allows for the partial update of an existing custom attribute identified by a unique identifier. The PATCH request requires the 'identifier' path parameter, which is a UUID representing the custom attribute to be updated. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body can include optional fields such as 'dataType', 'readOnly', 'hidden', and 'protected' to specify the new values for the custom attribute. Upon successful update, the API returns a 202 response with the updated custom attribute data and metadata. In case of an error, a 500 response with an error message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Custom Attributes

  • ID: patch_partially_update_custom_attributes
  • Operation: write
  • Entities: custom attribute
  • Summary: This API endpoint allows for the partial update of many existing custom attributes. The request is made using the PATCH method to the URL https://wxp-services.fountain.com/api/serviceworkforce/customAttributes. The request headers must include 'accept: application/json' and 'content-type: application/json'. The request body should be an array of custom attribute objects to be updated. The response will include the updated custom attributes wrapped in a JsonAPI root response, along with metadata such as timestamp, HTTP verb, path, and status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Existing Company

  • ID: patch_partially_update_existing_company
  • Operation: write
  • Entities: company
  • Summary: This API endpoint allows for partially updating an existing company identified by a unique identifier. The request is made using the PATCH method to the URL https://wxp-services.fountain.com/api/serviceorganizations/companies/{identifier}. The path parameter 'identifier' is required and should be a UUID representing the company's unique identifier. The request headers should include 'accept' and 'content-type' set to 'application/json'. The request body should contain the company data to be updated. The response will include the updated company data and metadata, wrapped in a JSON API root response. In case of an error, a default error response is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Existing EIN

  • ID: patch_partially_update_existing_ein
  • Operation: write
  • Entities: service organization, ein
  • Summary: This API endpoint allows for the partial update of an existing EIN (Employer Identification Number) in the system. The request is made using the PATCH method to the URL 'https://wxp-services.fountain.com/api/serviceorganizations/eins/{identifier}', where 'identifier' is a required path parameter representing the unique identifier of the EIN. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body can include the 'isDefault' field to specify if the EIN should be set as the default. Upon a successful update, the API returns a 202 response with the updated EIN details wrapped in a JsonAPI root response. In case of an error, a 500 response with an error message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Existing Employer

  • ID: patch_partially_update_existing_employer
  • Operation: write
  • Entities: employer
  • Summary: This API endpoint allows for the partial update of an existing employer identified by a unique identifier. The request is made using the PATCH method to the specified URL with the employer's identifier as a path parameter. The request headers should include 'accept' and 'content-type' set to 'application/json'. The request body should contain the partial data to update the employer, specifically the 'py/id' of the employer. Upon a successful request, the API returns a 202 status code with the updated employer data wrapped in a JsonAPI root response. In case of an error, a 500 status code is returned with a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Existing Job

  • ID: patch_partially_update_existing_job
  • Operation: write
  • Entities: job
  • Summary: This API endpoint allows for the partial update of an existing job using the PATCH method. The request requires a path parameter 'identifier' which is the unique identifier of the job to be updated. The request body should contain the job object with its internal identifier. The response returns the updated job data wrapped in a JsonAPI root response. In case of an error, a default error response is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Existing Location

  • ID: patch_partially_update_existing_location
  • Operation: write
  • Entities: location
  • Summary: This API endpoint allows for the partial update of an existing location identified by a unique identifier. The PATCH request requires the 'identifier' path parameter, which is a UUID representing the location. The request headers should include 'accept' and 'content-type' set to 'application/json'. The request body should contain the partial data to update the location. Upon successful update, the API returns a 202 status code with the updated location data wrapped in a JSON API root response. The response includes detailed information about the location such as UUID, creation and update timestamps, address details, and metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Location Groups

  • ID: patch_partially_update_location_groups
  • Operation: write
  • Entities: location group
  • Summary: This API endpoint allows for the partial update of multiple existing locationGroup objects. The request is made using the PATCH method to the specified URL. The request body must contain an array of locationGroup objects, each identified by a unique 'py/id'. The response will include the updated locationGroups wrapped in a JsonAPI root response. If successful, a 202 status code is returned. In case of an error, a 500 status code is returned with a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Many Existing Companies

  • ID: patch_partially_update_many_existing_companies
  • Operation: write
  • Entities: company
  • Summary: This API endpoint allows for the partial update of multiple existing companies. It uses the PATCH method and requires the request headers 'accept' and 'content-type' to be set to 'application/json'. The request body should be an array of company objects, each containing the 'py/id' property, which is required. The response returns a 202 status code with a JSON object containing the updated company data and metadata. The response includes detailed information about each company, such as UUID, creation and update timestamps, name, address, brand details, and various configuration options. In case of an error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Many Existing EINs

  • ID: patch_partially_update_many_existing_eins
  • Operation: write
  • Entities: service organization, ein
  • Summary: This API endpoint allows for the partial update of multiple existing EINs (Employer Identification Numbers) in the system. The request is made using the PATCH method to the specified URL. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body should be an array of EIN objects, each identified by a unique 'py/id'. The response, upon successful update, returns a 202 status code with a JSON object containing the updated EIN data and metadata about the request. In case of an error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Many Existing Employers

  • ID: patch_partially_update_many_existing_employers
  • Operation: write
  • Entities: employer
  • Summary: This API endpoint allows for the partial update of multiple existing employers. It uses the PATCH method and requires an array of employer objects in the request body, each with a unique identifier ('py/id'). The request headers should include 'accept' and 'content-type' set to 'application/json'. The response will return a 202 status code with the updated employers wrapped in a JsonAPI root response, or a 500 status code for a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Many Existing Jobs

  • ID: patch_partially_update_many_existing_jobs
  • Operation: write
  • Entities: job
  • Summary: This API endpoint allows for the partial update of many existing jobs. It uses the PATCH method and requires the request headers 'accept' and 'content-type' to be set to 'application/json'. The request body should be an array of job objects, each containing a unique identifier 'py/id'. The response will include a JSON object with updated job data and metadata. If successful, the response will have a status code of 202, indicating that the jobs have been updated. In case of an error, a default error response with status code 500 will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Many Existing Opensignups

  • ID: patch_partially_update_many_existing_opensignups
  • Operation: write
  • Entities: opensignup
  • Summary: This API endpoint allows for the partial update of many existing opensignups. The request is made using the PATCH method to the specified URL. The request body should contain an array of objects, each representing an opensignup to be updated, identified by a unique 'py/id'. The response will indicate whether the update was successful, with a 202 status code and a JSON object containing the updated opensignups and metadata. In case of an error, a 500 status code will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Multiple Data Groups

  • ID: patch_partially_update_multiple_data_groups
  • Operation: write
  • Entities: data group
  • Summary: This API endpoint allows for the partial update of multiple existing data groups. The request is made using the PATCH method to the URL https://wxp-services.fountain.com/api/servicestaff/dataGroups. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body should be an array of objects, each representing a data group to be updated, with a required 'py/id' field. The response returns a 202 status code with the updated data groups wrapped in a JSON API root response. The response body includes the updated data group details and metadata such as timestamp, HTTP verb, path, and request duration.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Multiple Locations

  • ID: patch_partially_update_multiple_locations
  • Operation: write
  • Entities: location
  • Summary: This API endpoint allows for the partial update of multiple existing locations. The request is made using the PATCH method to the URL https://wxp-services.fountain.com/api/serviceworkforce/locations. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body should be an array of location objects, each containing a 'py/id' property. The response returns a 202 status code with a JSON object containing updated location data and metadata. In case of an error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Multiple Workers

  • ID: patch_partially_update_multiple_workers
  • Operation: write
  • Entities: worker, location, company
  • Summary: This API endpoint allows for the partial update of multiple existing workers. The request is made using the PATCH method to the URL https://wxp-services.fountain.com/api/serviceworkforce/workers. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body should be an array of worker objects, each containing the 'py/id' property, which is required. The response will return a 202 status code with a JSON object containing the updated worker data and metadata if successful. In case of an error, a 500 status code with an error message will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Stored File

  • ID: patch_partially_update_stored_file
  • Operation: write
  • Entities: stored file
  • Summary: This API endpoint allows for the partial update of an existing stored file identified by a unique identifier. The PATCH method is used to update the metadata of the stored file. The request requires a path parameter 'identifier' which is a UUID representing the stored file. The request body should contain the metadata to be updated, such as the type of the file. The response returns a 202 status code with the updated stored file details wrapped in a JsonAPI root response. In case of an error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Partially Update Stored Files

  • ID: patch_partially_update_stored_files
  • Operation: write
  • Entities: stored file
  • Summary: This API endpoint allows for the partial update of multiple existing stored files. The request is made using the PATCH method to the URL https://wxp-services.fountain.com/api/servicemedia/storedFiles. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body should be an array of objects, each representing a stored file with a required 'py/id' field. The response returns a 202 status code with a JSON API root response containing the updated stored files and metadata. In case of an error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker

  • ID: patch_update_worker
  • Operation: write
  • Entities: worker
  • Summary: The Update Worker API allows you to update the details of a worker identified by their Worker ID. The API endpoint is accessed via a PATCH request to the URL https://api.fountain.com/v2/workers/{id}. The request requires a path parameter 'id' which is the Worker ID. The request headers should include 'accept' and 'content-type' set to 'application/json'. The request body should be a boolean value. The API returns a 200 OK response on success, with a complex JSON schema in the response body. If the request is unauthorized, a 401 Unauthorized response is returned. If the Worker ID is not found, a 404 Not Found response is returned. The response example is not provided in the documentation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Activate Worker

  • ID: post_activate_worker
  • Operation: write
  • Entities: worker
  • Summary: The Activate Worker API updates the worker's is_active attribute to true and marks the worker as 'Activated' in Posthire. It also reapplies recurring checks. The API requires a POST request to the endpoint https://api.fountain.com/v2/workers/{id}/activate with the worker ID specified in the path parameters. The request header can optionally include 'accept: application/json'. The response can be a 200 OK, 401 Unauthorized, or 404 Not Found, with the latter two providing a JSON object with a 'py/id' property.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Advance Multiple Applicants to a Specified Stage

  • ID: post_advance_multiple_applicants
  • Operation: write
  • Entities: applicant, stage, action
  • Summary: This API endpoint allows you to advance multiple applicants to a specified destination stage within an opening. You can advance up to 500 applicants at a time. The request requires a 'stage_id' as a query parameter, which is the destination stage's external ID. The request body must include an array of applicant IDs under 'ids'. Optionally, you can specify a 'funnel_id' to move applicants to a different funnel, and set 'skip_automated_actions' to true if you want to skip automated actions associated with the destination stage. Successful requests will trigger automated actions unless skipped. If the request fails, no applicants will be moved. The response includes a 204 status code for success and a 401 status code for unauthorized access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Book an Available Slot with an Applicant

  • ID: post_book_available_slot
  • Operation: write
  • Entities: applicant, slot
  • Summary: This API endpoint allows you to book an available slot with an applicant. The request requires the 'id' path parameter, which is the Available Slot ID. Optionally, you can include the 'applicant_id' query parameter to specify the unique identifier for the applicant to be associated with the booked slot. The request does not require a body. The response will return a 201 status code with details of the booked slot, including the slot ID, location, recruiter, start and end times, booked time, instructions, whether the applicant showed up, and the stage title. If unauthorized, a 401 status code is returned, and if the slot is not found, a 404 status code is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Cancel a Booked Slot

  • ID: post_cancel_booked_slot
  • Operation: write
  • Entities: booked slot
  • Summary: This API endpoint is used to cancel a booked slot identified by the 'id' path parameter. The request is made using the POST method to the URL 'https://api.fountain.com/v2/booked_slots/{id}/cancel'. The 'id' parameter is required and specifies the booked slot to be canceled. An optional query parameter 'page' can be included to specify the page of results to view. The request header can include 'accept: application/json' to specify the desired response format. The API returns a 204 status code for a successful cancellation or a 401 status code if the request is unauthorized, with an error message in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an Applicant

  • ID: post_create_an_applicant
  • Operation: write
  • Entities: applicant, secure field, funnel
  • Summary: The Create an Applicant API allows you to create a new applicant by providing required attributes such as name, email, and phone number. The email must be a valid email address, and the phone number must be a string. Optionally, you can specify a funnel_id to place the applicant in a specific opening. If the account has WhatsApp enabled, set the phone_platform to 'whats_app'. You can also include secure data fields for sensitive information, which are encrypted in the system. The API checks for duplicate applicants based on your organization's settings, and you can opt-in for additional duplicate filtering rules by setting check_if_applicant_is_duplicate to true. The response returns a unique identifier for the created applicant.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Custom Attributes

  • ID: post_create_custom_attributes
  • Operation: write
  • Entities: custom attribute
  • Summary: This API endpoint allows the creation of one or multiple custom attributes in the service workforce system. The request is made via a POST method to the specified URL. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body can either be a single object or an array of objects, each containing 'dataType', 'readOnly', 'hidden', and 'protected' fields. The response will include the created custom attribute(s) wrapped in a JSON API root response. In case of a successful creation, a 201 status code is returned. If an error occurs, a 500 status code is returned with a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Custom Exports

  • ID: post_create_custom_exports
  • Operation: write
  • Entities: export, template
  • Summary: The Create Custom Exports API allows users to create a custom export based on a specified template ID. The endpoint requires a 'template_id' as a query parameter to identify the template for the export. The response includes details about the created export, such as its ID, creation and update timestamps, status, and a file URL for downloading the export. The file URL is valid for one week. If the request is unauthorized, a 401 error is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Data Groups

  • ID: post_create_data_groups
  • Operation: write
  • Entities: data group
  • Summary: This API endpoint allows the creation of one or multiple data groups. It requires a POST request to the specified URL with headers 'accept' and 'content-type' set to 'application/json'. The request body can either be a single data group object or an array of data group objects, each identified by a unique 'py/id'. Upon successful creation, the API returns a 201 response with the created data group(s) details, including 'uuid', 'createdAt', 'createdBy', 'lastUpdatedAt', 'lastUpdatedBy', 'label', and 'lookerGroupId'. The response also includes metadata such as 'timestamp', 'verb', 'path', 'jti', 'rid', 'count', 'status', and 'duration'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create EINs for Service Organizations

  • ID: post_create_eins_for_service_organizations
  • Operation: write
  • Entities: service organization, ein
  • Summary: This API endpoint allows the creation of one or multiple EINs (Employer Identification Numbers) for service organizations. The request is made using the POST method to the specified URL. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body can either be a single EIN object or an array of EIN objects, each identified by a unique 'py/id'. The response, upon successful creation, returns a 201 status code with a JSON object containing the details of the created EIN(s), including UUID, creation timestamps, and other metadata. In case of an error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Employers

  • ID: post_create_employers
  • Operation: write
  • Entities: employer
  • Summary: This API endpoint allows the creation of one or multiple employers. The request is made using the POST method to the URL https://wxp-services.fountain.com/api/servicestaff/employers. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body can either be a single employer object or an array of employer objects, each with a required 'py/id' property. Upon successful creation, the response will include the created employer data and metadata. If there is an error, a default error response will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Jobs

  • ID: post_create_jobs
  • Operation: write
  • Entities: job
  • Summary: This API endpoint allows the creation of one or multiple job entries in the system. The request is made via a POST method to the specified URL. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body can either be a single job object or an array of job objects, each requiring a unique identifier 'py/id'. Upon successful creation, the API returns a 201 status code with the created job data and metadata in the response body. In case of an error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Location Groups

  • ID: post_create_location_groups
  • Operation: write
  • Entities: location group
  • Summary: This API endpoint allows the creation of one or multiple location groups. The request is made via a POST method to the specified URL. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body can either be a single location group object or an array of location group objects, each identified by a unique 'py/id'. Upon successful creation, the response will include the created location group(s) data and metadata. If an error occurs, a default error response is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Locations

  • ID: post_create_locations
  • Operation: write
  • Entities: location
  • Summary: This API endpoint allows the creation of one or multiple locations. The request is made using the POST method to the URL https://wxp-services.fountain.com/api/serviceworkforce/locations. The request headers must include 'accept' and 'content-type' both set to 'application/json'. The request body can either be a single location object or an array of location objects, each with a required 'py/id' property. Upon successful creation, the response will include the created location(s) wrapped in a JsonAPI root response, with a 'data' field containing the location details and a 'meta' field for additional information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Available Slot

  • ID: post_create_new_available_slot
  • Operation: write
  • Entities: slot, stage, recruiter
  • Summary: This API endpoint allows the creation of a new available slot for appointments. It requires a POST request to the URL https://api.fountain.com/v2/available_slots with headers specifying 'accept' and 'content-type' as 'application/json'. The request body must include 'recruiter_email', 'start_time', 'end_time', and 'max_attendees' as required fields. Optional fields include 'location', 'instructions', 'frequency', 'split', 'period', 'title', 'stage_ids', and 'opening_stage_ids'. The response will return a 201 status code with details of the created slot or a 401 status code if unauthorized.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Hiring Goal

  • ID: post_create_new_hiring_goal
  • Operation: write
  • Entities: hire, opening, hiring goal
  • Summary: This API endpoint allows the creation of a new Hiring Goal in the system. It requires a POST request to the URL https://api.fountain.com/v2/hiring_goals with headers specifying 'accept' and 'content-type' as 'application/json'. The request body must include 'start_date', 'hire_by', 'goal', and 'opening_id' as required fields. Upon successful creation, it returns a 201 status code with details of the hiring goal, including 'external_id', 'goal', 'hire_by', 'start_date', 'hires_count', 'past_due', 'remaining_days', 'status', and 'closed_at'. Unauthorized access returns a 401 status code, and a 501 status code indicates the feature is not implemented.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Location

  • ID: post_create_new_location
  • Operation: write
  • Entities: opening, location, account
  • Summary: This API endpoint allows the creation of a new location in the system. It requires a POST request to the URL https://api.fountain.com/v2/locations with headers specifying 'accept' and 'content-type' as 'application/json'. The request body must be a JSON object with a specific structure, including a 'py/object' field indicating the Python object type and a 'properties' field containing a 'py/id'. Upon successful creation, the API returns a 201 status code with a detailed JSON response containing information about the newly created location, such as 'account_id', 'address', 'country_code', 'id', 'language', 'location_group', 'name', 'owner', 'openings_count', 'openings', 'time_zone', 'twilio_number', 'whats_app_number', and 'customer_attributes'. If unauthorized, a 401 status code is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Location Group

  • ID: post_create_new_location_group
  • Operation: write
  • Entities: location group, customer attribute, location
  • Summary: This API endpoint allows the creation of a new location group in the system. The request is made using the POST method to the URL https://api.fountain.com/v2/location_groups. The request headers should include 'accept' and 'content-type' set to 'application/json'. The request body must include the 'name' of the location group, and optionally, the 'owner_id' and 'customer_attributes'. The response will return a 201 status code upon successful creation, including details such as 'account_id', 'name', 'id', 'owner', 'locations', and 'customer_attributes'. If unauthorized, a 401 status code will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Opening

  • ID: post_create_new_opening
  • Operation: write
  • Entities: opening, workflow, location
  • Summary: The 'Create a New Opening' API allows users to create a new job opening in the system. The API requires a POST request to the endpoint 'https://api.fountain.com/v2/funnels' with headers specifying 'accept' and 'content-type' as 'application/json'. The request body must include the 'title', 'location_id', and 'position_id' as required fields, along with optional fields such as 'use_workflow', 'workflow_id', 'active', 'compensation', and more. The response will include details of the created opening, such as 'title', 'description', 'apply_url', 'id', 'address', 'time_zone', 'requirements', and other attributes related to the job opening. The API also handles unauthorized access with a 401 error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Position

  • ID: post_create_new_position
  • Operation: write
  • Entities: position
  • Summary: This API endpoint allows the creation of a new position in the system. It requires a POST request to the URL https://api.fountain.com/v2/positions with headers specifying 'accept' and 'content-type' as 'application/json'. The request body must include the 'name' of the position as a required field, and optionally 'confirmation_message', 'description', 'requirements', and 'customer_attributes'. The response will include details of the created position such as 'account_id', 'confirmation_message', 'description', 'name', 'id', 'openings_count', 'openings', 'requirements', and 'customer_attributes'. A successful creation returns a 201 status code, while an unauthorized request returns a 401 status code.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Open Signups

  • ID: post_create_open_signups
  • Operation: write
  • Entities: opensignup
  • Summary: This API endpoint allows the creation of one or multiple open signups. The request is made using the POST method to the specified URL. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body can either be a single object or an array of objects, each representing an opensignup with a required 'py/id' property. Upon successful creation, the API returns a 201 status code with a JSON response containing the created opensignup data and metadata. In case of an error, a default error response is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Timestamped Exports

  • ID: post_create_timestamped_exports
  • Operation: write
  • Entities: export, file, template
  • Summary: The Create Timestamped Exports API allows users to create a timestamped export based on a specified template_id. The request requires a JSON body with 'template_id' and 'output' fields, where 'template_id' is the ID of the template to generate the report from, and 'output' specifies the format of the report (csv or xlsx). The response includes the export's ID, creation and update timestamps, state, file URL, and template details. The file URL will expire one week from creation. The API returns a 201 status code on success and a 401 status code if unauthorized.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Workers

  • ID: post_create_workers
  • Operation: write
  • Entities: job, worker, company
  • Summary: The Create Workers API allows the creation of one or multiple worker records in the system. The API endpoint is accessed via a POST request to the URL https://wxp-services.fountain.com/api/serviceworkforce/workers. The request must include headers specifying 'accept' and 'content-type' as 'application/json'. The request body can either be a single worker object or an array of worker objects, each containing properties such as 'segmentEnabled', 'messagingEnabled', 'ssoEnabled', 'isTestWorker', 'importUpdatesLocked', and 'technicalOptions'. The response, upon successful creation, returns a 201 status code with a JSON object containing the worker data, including identifiers, timestamps, personal and work details, and other attributes. In case of an error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Creating Applicant Notes

  • ID: post_creating_applicant_notes
  • Operation: write
  • Entities: option bank, note, application
  • Summary: The 'Creating Applicant Notes' API allows users to create notes for applicants by sending a POST request to the specified endpoint. The request requires headers specifying 'accept' and 'content-type' as 'application/json'. The request body should include a JSON object with 'py/object' and 'py/id' properties. Upon successful creation, the API returns a 201 response with the note's ID, name, and options. If unauthorized, a 401 response is returned. The response includes detailed information about the created note or an error message if an issue occurs.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Deactivate Worker

  • ID: post_deactivate_worker
  • Operation: write
  • Entities: check, worker, message
  • Summary: The Deactivate Worker API updates the worker's is_active attribute to false and marks the worker as 'Deactivated' in Posthire. It cancels all active recurring checks and follow-up messages for the specified applicant. The API requires the worker's ID as a path parameter. The request does not require a body. The response can be a 200 OK, 401 Unauthorized, or 404 Not Found, with appropriate error details in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Generate API Key

  • ID: post_generate_api_key
  • Operation: write
  • Entities: API key
  • Summary: This API endpoint generates a new API key. It requires a POST request to the specified URL with a JSON body containing a 'label' for the API key. The request headers must include 'accept' and 'content-type' set to 'application/json'. The response includes a 'data' object with details about the generated API key, such as 'uuid', 'createdAt', 'key', 'secret', and 'label'. Additionally, a 'meta' object provides metadata about the request, including 'timestamp', 'verb', 'path', 'status', and 'duration'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Link Upload Secure Document for Applicant

  • ID: post_link_upload_secure_document_for_applicant
  • Operation: write
  • Entities: applicant, file, document
  • Summary: This API endpoint is used to complete the process of adding files to an applicant's profile in Fountain. It is the second step in the process, where the file is linked to the applicant's profile after being uploaded to S3. The request requires the applicant's ID as a path parameter, and the request body must include the S3 key, Fountain's file identifier (key), and the file size. The response indicates whether the file was successfully uploaded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Notify Applicant via SMS and Email

  • ID: post_notify_applicant_via_sms_and_email
  • Operation: write
  • Entities: applicant, notification, application
  • Summary: This API endpoint allows you to notify an applicant via SMS and email to continue their application using the provided PORTAL_URL. The request requires the applicant's email and phone number in the request body. The response will include a message indicating the result of the notification. If unauthorized, a 401 error will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Booked Interview Sessions for Applicants

  • ID: post_retrieve_booked_interview_sessions
  • Operation: read
  • Entities: applicant, recruiter, interview session
  • Summary: This API endpoint retrieves all booked interview sessions for every applicant specified within your account, starting from the creation of each applicant. You can search for up to 1000 applicants at once. The request requires headers specifying 'accept' and 'content-type' as 'application/json'. The request body must include an array of applicant IDs, and optionally a funnel ID and a boolean to skip automated actions. The response includes details of each interview session such as start/end time, location, recruiter, and instructions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Transition History for Applicants

  • ID: post_retrieve_transition_history_for_applicants
  • Operation: read
  • Entities: applicant, stage, transition
  • Summary: This API endpoint retrieves the transition history for all specified applicants within your account. It returns the workflow stage name and the date/time of each transition for up to 1000 applicants at once. The request requires a list of applicant IDs in the request body. The response includes detailed transition information for each applicant, or an error message if unauthorized.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Send Worker Message

  • ID: post_send_worker_message
  • Operation: write
  • Entities: worker, message, service
  • Summary: The Send Worker Message API allows you to send messages to a list of workers identified by their unique UUIDs. The request body must include the 'workerUuids' and 'producer' fields. Optionally, you can include 'email' and 'sms' objects to specify the content of the message. The 'email' object requires 'subject' and 'content', while the 'sms' object requires 'content'. The 'replyTo' field can be used to specify a reply-to email address. The API responds with the number of workers that were successfully messaged.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Terminate External Applicant

  • ID: post_terminate_external_applicant
  • Operation: write
  • Entities: applicant, worker, process
  • Summary: The Terminate External Applicant API is used to terminate an external applicant in the system. It requires a POST request to the specified URL with a JSON body containing the applicant's details. The request body must include the applicant's email and ID, and may optionally include their first name, last name, and full name. The API returns a 204 status code indicating successful termination of the worker, but no response body is provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Upload and Process Service Media Files

  • ID: post_upload_and_process_service_media_files
  • Operation: write
  • Entities: metadata, file, location
  • Summary: This API endpoint allows users to upload and process service media files. The request is made to the URL https://wxp-services.fountain.com/api/servicemedia/processes/files/edm using the POST method. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body requires 'name', 'companyUuid', and 'metadata' fields, where 'metadata' includes 'size', 'mimeType', and 'type'. The response returns a JSON object containing the file details and a presign URL for uploading the file.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Upload Files to Storage Folder

  • ID: post_upload_files_to_storage_folder
  • Operation: write
  • Entities: worker, file, storage folder
  • Summary: This API endpoint allows users to upload files to a specified storage folder. The request requires a path parameter 'storageFolder' which specifies the target storage folder. The request body must include a 'fileUrl' which is the URL of the file to be uploaded. Optionally, 'fileUrlBack' can be provided for image formats to concatenate files, and 'workerUuid' if using a worker-related file storage option. The response returns a stored file document with details such as UUID, creation and update timestamps, file metadata, and storage location.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Upload Secure Document to Applicant Profile

  • ID: post_upload_secure_document_to_applicant_profile
  • Operation: write
  • Entities: applicant, file, secure document
  • Summary: This API endpoint is used to upload secure documents to an applicant's profile in Fountain. It is the first step in a two-step process to add files to an applicant's profile. The request requires a valid applicant ID in the path parameters and a filename in the request body. The API key must be included in the headers for authentication. Upon successful request, the response provides a URL and form data necessary to upload the file to S3. The response also includes details such as the host, file size limits, and encryption details. If secure data access is required, contact [email protected] to enable access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Workflow Reassignment for Applicants

  • ID: post_workflow_reassignment_for_applicants
  • Operation: write
  • Entities: applicant, stage, workflow
  • Summary: The Workflow Reassignment API allows users to move applicants from one stage to another within different workflows. It requires a stage mapping array that specifies the source and destination stages. The request body must include the destination workflow ID, title, a flag to run landing actions, the source opening ID, and the stage mappings. The API is in Alpha, and users need to contact their account representative to use it. The response can be a 204 No Content for success, 401 Unauthorized if access is denied, or 403 Forbidden if the action is not allowed.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Advance Applicant in Opening

  • ID: put_advance_applicant_in_opening
  • Operation: write
  • Entities: applicant, stage, funnel
  • Summary: This API endpoint advances an applicant to a specified stage in an opening. If no stage_id is provided, the applicant will be moved to the next stage by default. When specifying a stage_id, a funnel_id must also be provided. The API also allows skipping automated actions associated with the target stage by setting the skip_automated_actions parameter to true. The request requires the applicant's ID as a path parameter and accepts JSON formatted request bodies. The response will be a 204 No Content on success or a 401 Unauthorized if access is denied. The request headers must include 'accept', 'content-type', and 'X-ACCESS-TOKEN' which is your Fountain app's API token.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Remove an Option Bank Option

  • ID: put_remove_option_bank_option
  • Operation: write
  • Entities: option bank
  • Summary: The 'Remove an Option Bank Option' API allows users to append options to an existing option bank by specifying the option bank ID in the path and the options in the query parameters. The request is made using the PUT method to the endpoint 'https://api.fountain.com/v2/option_banks/{id}/append'. The 'id' path parameter is required and should be a string representing the option bank's ID. The 'options' query parameter is also required and should be an object containing an array of options, each with a 'label' and 'value'. The response will return a 200 status code with the updated option bank details if successful, or a 401 status code if unauthorized.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace Company by Identifier

  • ID: put_replace_company_by_identifier
  • Operation: write
  • Entities: service organization, company
  • Summary: This API endpoint allows you to replace a company identified by a unique identifier. The request requires a path parameter 'identifier' which is a UUID representing the company. The request body must contain a JSON object representing the company to be replaced. The response will return the replaced company data wrapped in a JsonAPI root response. If the company does not exist, it will be created. The response includes the company data and metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace Custom Attribute

  • ID: put_replace_custom_attribute
  • Operation: write
  • Entities: custom attribute
  • Summary: This API endpoint allows you to replace a custom attribute, whether it exists or not, in the Fountain service workforce. The endpoint requires a PUT request to the specified URL with a unique identifier for the custom attribute in the path. The request must include headers specifying 'accept' and 'content-type' as 'application/json'. The body of the request should contain the data type, read-only status, hidden status, and protected status of the custom attribute. Upon successful replacement, the API returns a 202 response with details of the replaced custom attribute, including its UUID, creation and update timestamps, label, key, data type, and other attributes. In case of an error, a 500 response is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace Custom Attributes

  • ID: put_replace_custom_attributes
  • Operation: write
  • Entities: custom attribute
  • Summary: This API endpoint allows you to replace multiple custom attributes, whether they exist or not, in the system. The request is made using the PUT method to the URL https://wxp-services.fountain.com/api/serviceworkforce/customAttributes. The request headers should include 'accept' and 'content-type' set to 'application/json'. The request body should be an array of custom attribute objects, each containing properties such as 'py/object', 'x-name', 'type', 'required', and 'properties'. The response will return a 202 status code if successful, with a JSON body containing the updated custom attributes and metadata. In case of an error, a 500 status code with an error message will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace EIN for Service Organization

  • ID: put_replace_ein_for_service_organization
  • Operation: write
  • Entities: service organization, ein
  • Summary: This API endpoint allows the replacement of an EIN (Employer Identification Number) for a service organization. The request is made using the PUT method to the URL 'https://wxp-services.fountain.com/api/serviceorganizations/eins/{identifier}', where 'identifier' is a required path parameter representing the unique EIN identifier in UUID format. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body can optionally include a boolean 'isDefault' to specify if the EIN is the default one. Upon successful replacement, the API returns a 202 response with details of the EIN, including its UUID, creation and update timestamps, label, and associated hire brand IDs. In case of an error, a 500 response with an error message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace Employer

  • ID: put_replace_employer
  • Operation: write
  • Entities: location, employer, company
  • Summary: This API endpoint allows you to replace an existing employer or create a new one if it does not exist. The request is made to the URL 'https://wxp-services.fountain.com/api/servicestaff/employers/{identifier}' using the PUT method. The 'identifier' path parameter is required and should be a UUID representing the unique identifier of the employer. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body should contain the employer object to replace the existing one. Upon successful replacement, a 202 response is returned with detailed information about the employer, including UUID, timestamps, company details, and more. In case of an error, a 500 response is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace Job by Identifier

  • ID: put_replace_job_by_identifier
  • Operation: write
  • Entities: job
  • Summary: This API endpoint allows you to replace a job identified by a unique identifier. The request is made using the PUT method to the URL https://wxp-services.fountain.com/api/serviceworkforce/jobs/{identifier}. The path parameter 'identifier' is required and should be a UUID representing the job's unique identifier. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body should contain a job object with specific properties. Upon successful replacement, the API returns a 202 response with the job data wrapped in a JsonAPI root response. In case of an error, a 500 error response is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace Location

  • ID: put_replace_location
  • Operation: write
  • Entities: location
  • Summary: The Replace Location API allows you to replace an existing location or create a new one if it does not exist. The API requires a unique identifier for the location in the path parameter. The request body should contain the location object with its ID. The response returns the replaced location data wrapped in a JsonAPI root response. If the operation is successful, a 202 status code is returned. In case of an error, a 500 status code is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace Location Group

  • ID: put_replace_location_group
  • Operation: write
  • Entities: location group
  • Summary: This API endpoint allows the user to replace an existing location group identified by a unique identifier. The request is made using the PUT method to the specified URL with the identifier as a path parameter. The request headers should include 'accept' and 'content-type' set to 'application/json'. The request body should contain the locationGroup object to replace the existing one. The response will return a 202 status code if the location group is successfully replaced, wrapped in a JsonAPI root response. In case of an error, a 500 status code is returned with a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace Location Groups

  • ID: put_replace_location_groups
  • Operation: write
  • Entities: location group
  • Summary: This API endpoint is used to replace multiple location groups, whether they exist or not, at the specified URL. The request method is PUT, and it requires headers specifying 'accept' and 'content-type' as 'application/json'. The request body should be an array of objects, each representing a location group with specific properties and identifiers. The response, upon successful replacement, returns a 202 status code with a JSON API root response containing the replaced location groups. In case of an error, a 500 status code is returned with a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace Multiple Companies

  • ID: put_replace_multiple_companies
  • Operation: write
  • Entities: service organization, company
  • Summary: This API endpoint allows the replacement of multiple companies, whether they exist or not, in the system. The request is made using the PUT method to the URL https://wxp-services.fountain.com/api/serviceorganizations/companies. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body should be an array of company objects, each containing a unique identifier 'py/id'. The response returns a 202 status code with a JSON API root response containing the replaced companies' data and metadata. In case of an error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace Multiple EINs

  • ID: put_replace_multiple_eins
  • Operation: write
  • Entities: response, service organization, ein
  • Summary: The Replace Multiple EINs API allows users to replace multiple Employer Identification Numbers (EINs) in the system. The API endpoint is accessed via a PUT request to the specified URL. The request must include headers for 'accept' and 'content-type' set to 'application/json'. The request body should contain an array of EIN objects, each with a unique identifier ('py/id'). The response will include a 202 status code if successful, with a JSON body containing the replaced EINs and metadata about the request. In case of an error, a 500 status code with an error message will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace Multiple Employers

  • ID: put_replace_multiple_employers
  • Operation: write
  • Entities: employer
  • Summary: This API endpoint allows for replacing multiple employers, whether they exist or not, using a PUT request to the specified URL. The request requires an array of employer objects in the body, each with a unique identifier 'py/id'. The response will return a 202 status code with a list of replaced employers and metadata if successful, or a 500 status code for a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace Multiple Jobs

  • ID: put_replace_multiple_jobs
  • Operation: write
  • Entities: job
  • Summary: The Replace Multiple Jobs API allows users to replace multiple job entries, whether they exist or not, in the system. The API endpoint is accessed via a PUT request to the specified URL. The request must include headers specifying 'accept' and 'content-type' as 'application/json'. The request body should be an array of job objects, each containing properties such as 'py/object', 'x-name', 'type', 'required', and 'properties'. The response will return a 202 status code if the jobs are successfully replaced, wrapped in a JsonAPI root response. In case of an error, a 500 status code is returned with a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Replace Multiple Locations

  • ID: put_replace_multiple_locations
  • Operation: write
  • Entities: location
  • Summary: This API endpoint allows the user to replace multiple locations, whether they exist or not, by sending a PUT request to the specified URL. The request does not require any specific query parameters or path parameters. The request body should contain an array of location objects in JSON format. The response will return a 202 status code if the locations are successfully replaced, wrapped in a JsonAPI root response. In case of an error, a 500 status code will be returned with a default error response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Applicant Information

  • ID: put_update_applicant_information
  • Operation: write
  • Entities: applicant, address, secure field
  • Summary: The Update Applicant Information API allows you to update an applicant's information using the PUT method at the endpoint https://api.fountain.com/v2/applicants/{id}. The API accepts path parameters, headers, and a request body. The path parameter 'id' is required and specifies the unique identifier of the applicant to be updated. The request headers must include 'accept', 'content-type', and 'X-ACCESS-TOKEN', all of which are required. The request body can include optional fields such as 'name', 'email', 'phone_number', 'data', 'secure_data', and 'rejection_reason'. The 'data' field can contain complex objects like addresses, and 'secure_data' is used for sensitive information. The response includes detailed information about the applicant, including personal details, secure data, and various related objects like addresses, background checks, and document uploads. The API returns a 200 OK response on success, with a detailed JSON object containing the updated applicant information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Applicant Labels

  • ID: put_update_applicant_labels
  • Operation: write
  • Entities: applicant, label
  • Summary: This API endpoint allows updating a list of labels for a specific applicant. It can be used to add new labels or delete existing ones. The request requires the applicant's unique identifier and the label title as path parameters. Optional query parameters include 'completed' to indicate if the update is finished and 'completed_at' to specify the completion timestamp. The response returns a list of labels associated with the applicant if successful, or an error message if unauthorized access occurs.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Applicant Note

  • ID: put_update_applicant_note
  • Operation: write
  • Entities: applicant, user, note
  • Summary: The Update Applicant Note API allows users to update a specific note associated with an applicant. The API requires the applicant's ID and the note's ID as path parameters. The request must include headers specifying the content type as 'application/json'. The request body should contain the necessary data to update the note. Upon a successful request, the API returns the updated note details, including the note's ID, content, timestamps, and user information. If unauthorized access is attempted, a 401 error is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Existing Location

  • ID: put_update_existing_location
  • Operation: write
  • Entities: opening, location group, location
  • Summary: The Update Existing Location API allows users to update the details of an existing location by providing the location ID in the path parameters and the necessary data in the request body. The API requires 'accept' and 'content-type' headers to be set to 'application/json'. The request body must include a 'py/id' field. Upon a successful request, the API returns a detailed JSON object containing the updated location information, including account ID, address, country code, language, location group details, and more. If the request is unauthorized or the location is not found, appropriate error responses are returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Existing Opening

  • ID: put_update_existing_opening
  • Operation: write
  • Entities: opening, location, position
  • Summary: The 'Update an Existing Opening' API allows users to update the details of an existing job opening in the system. The API requires the Opening ID as a path parameter and accepts a JSON body with various optional fields such as title, location_id, position_id, workflow_id, and more to update the opening's details. The response includes the updated details of the opening, including title, description, apply_url, and other relevant information. The API supports updating attributes like compensation, job type, job industry, and more, providing flexibility in managing job openings.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Existing Position

  • ID: put_update_existing_position
  • Operation: write
  • Entities: opening, customer attribute, position
  • Summary: This API endpoint allows you to update an existing position in the system. You need to provide the Position ID in the path parameters. The request body should include details such as the confirmation message, description, name, requirements, and any customer attributes related to the position. The response will return the updated position details including account ID, confirmation message, description, name, position ID, number of openings, and customer attributes. If the request is unauthorized, a 401 error will be returned. If the position is not found, a 404 error will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Existing Hiring Goal

  • ID: put_update_hiring_goal
  • Operation: write
  • Entities: hiring goal
  • Summary: This API endpoint allows you to update an existing Hiring Goal by sending a PUT request to the specified URL with the Hiring Goal ID in the path. The request must include headers specifying 'accept' and 'content-type' as 'application/json'. The request body should contain the 'start_date', 'hire_by', 'goal', and 'opening_id' fields. The response will return a 202 status code with details of the updated Hiring Goal, including 'external_id', 'goal', 'hire_by', 'start_date', 'hires_count', 'past_due', 'remaining_days', 'status', and 'closed_at'. Possible error responses include 401 Unauthorized, 404 Not Found, and 501 Not Implemented.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Location Group

  • ID: put_update_location_group
  • Operation: write
  • Entities: location group, customer attribute, location
  • Summary: The Update Location Group API allows you to update an existing location group by specifying the location group ID in the path parameters. The request requires a JSON body with the name of the location group as a mandatory field, and optionally, the owner ID, move to group ID, and customer attributes. The API returns a 200 OK response with the updated location group details if successful. If unauthorized, a 401 error is returned, and if the location group is not found, a 404 error is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Option Bank

  • ID: put_update_option_bank
  • Operation: write
  • Entities: option bank
  • Summary: The Update Option Bank API allows you to update the details of an existing option bank identified by its unique ID. The request requires a path parameter 'id' which is the unique identifier of the option bank. The request headers must include 'accept' and 'content-type' both set to 'application/json'. The request body must include a JSON object with a 'py/id' property. The response will return a 200 status code with the updated option bank details including 'id', 'name', and 'options' if successful. If unauthorized, a 401 status code with an error identifier will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Specific User

  • ID: put_update_specific_user
  • Operation: write
  • Entities: time zone, role, user
  • Summary: This API endpoint allows updating a specific user in the system. The request is made to the URL 'https://api.fountain.com/v2/users/{id}' using the PUT method. The 'id' path parameter is required to specify which user to update. The request body can include optional fields such as 'name', 'time_zone', and 'role_id' to update the user's details. The response returns the updated user information including 'name', 'id', and 'email'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update User Opening Access

  • ID: put_update_user_opening_access
  • Operation: write
  • Entities: opening, workflow, user
  • Summary: This API endpoint allows updating the opening access permissions for a specific user identified by user_id. It is only available if the account is using the workflow system for configuring openings and stages. The request requires a path parameter 'user_id' and a JSON body that can include 'funnels_admin', 'funnel_permissions', and 'workflow_permissions'. The 'funnels_admin' boolean grants full access to openings if set to true. 'funnel_permissions' is an array of objects specifying funnel_id and full_access, and 'workflow_permissions' is an array of objects specifying workflow_id and stage_id. A successful request returns no content.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Worker Custom Attribute

  • ID: put_update_worker_custom_attribute
  • Operation: write
  • Entities: custom attribute, worker
  • Summary: This API endpoint is used to update a custom attribute for a specific worker. It requires the worker's unique identifier and the custom attribute's unique identifier as path parameters. The request body must include a 'value' field, which can be a string, array, object, or boolean. The response returns the updated custom attribute data, including its UUID and value.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated 7 days ago