Sourceflow API (1.0.0)

Obtain a Bearer token using the OAuth 2.0 client credentials flow. The returned token is valid for 1 hour and must be included in subsequent authenticated requests as Authorization: Bearer TOKEN.

Returns all job records.

Create a new job posting. external_reference and url_slug must be unique. Set skip_webhook: true in the top-level body to suppress job webhooks.

If a job with the given external_reference exists it will be updated; otherwise a new job will be created. Returns an action field indicating whether the record was created or updated. Set skip_webhook: true in the top-level body to suppress job webhooks.

Same upsert behaviour as /jobs/update_or_create.json but accepts human-readable category names (e.g. sector names) instead of UUIDs. Use /jobs/simplified_categories.json to retrieve the available names. Set skip_webhook: true in the top-level body to suppress job webhooks.

Partially update an existing job. Only fields included in the payload will be changed. Setting a field to null will clear its value.

The {jobId} can be either the external_reference used when creating the job, or the Sourceflow UUID returned on creation. Set skip_webhook: true in the top-level body to suppress job webhooks.

Permanently delete a job from the website and search index. This cannot be undone and will remove the job's web page (potentially breaking existing links).

If you only want to hide a job, use PATCH to set expires_at to a date in the past.

The {jobId} can be either the external_reference or the Sourceflow UUID.

Returns an array of external_reference strings for all currently live jobs.

Check whether a job's page has been published and is publicly accessible. When a job is first created there is a short delay before the page is live. Poll this endpoint to know when the job is available.

Returns jobs similar to a specified job, based on category matching.

Search and filter the job index. Supports text queries, category filters, and commute-time filtering. Pagination is supported via page_token.

Returns all job categories with their metadata.

Returns all categories in a simplified format designed for use with the /jobs/update_or_create_simplified.json endpoint. Keys match the field names accepted by that endpoint.

Returns detailed information for a single category including all of its values.

Returns all CMS categories.

Creates a new CMS category with a defined schema.

Returns a specific CMS category by ID, including its schema and all values.

Replaces the definition of an existing CMS category including its schema.

Creates a new value in the specified CMS category. Keys in schema_attributes must match the field names defined in the category's schema.

• form fields: pass the UUID of the form
• category fields: pass the UUID of a value from the referenced category
• object fields: pass an array of objects, each with a generated UUID and field values
• file fields: reference files by field name in the top-level files object, providing a filename and base64-encoded content

Replaces the data for an existing category value. Keys in schema_attributes must match the field names defined in the category's schema.

Pass attachment IDs in attachments_to_delete to remove existing files. Add new files via the files object using base64-encoded content.

Returns all placement records.

Placement is located by external_placement_id. If found it will be updated; otherwise a new placement record is created.

Deletes a placement identified by the external_placement_id query parameter.

Creates a webhook that fires when subscribed events occur.

Supports job_application and form_submission event types in any combination. For form_submission triggers, omit form_id to receive all form submissions, or set it to restrict to a specific form. Use excluded_form_ids to receive all submissions except from specific forms (set form_id to null in this case).

Custom headers are included in every outgoing webhook POST and can be used for recipient-side authentication.

Returns an example of the payload that would be sent to a webhook endpoint.

Resends a previously fired webhook event using its event_id. Any expiring URLs or signatures in the payload are refreshed. Events can be retriggered for up to 90 days after they were first sent.

Returns schema information for each form, describing what data is collected. Useful for understanding what fields will appear in a form_submission webhook payload.

Sends an email via the Sourceflow platform.

Use application/json for plain or HTML emails without attachments. Use multipart/form-data when including file attachments.