Generated by API Evangelist
Written by API Evangelist tooling for Bindbee's API. It is a proposal applied on top of the contract, not a document Bindbee publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Bindbee Activity API
version: 1.0.0
extends: openapi/bindbee-activity-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/api/ats/v1/activities'].get
update:
x-apievangelist-phrasing:
intent: List candidate activities in the ATS
effect: read
questions:
- Which notes, emails and other activities are logged against a candidate in our ATS?
- Can I see only the activities a particular recruiter recorded?
- What activity entries changed since yesterday's sync?
instructions:
- text: List every activity logged for candidate {candidate}.
slots:
candidate: query.candidate
- text: Show activities recorded by ATS user {user}.
slots:
user: query.user
- text: Pull activities modified after {modified_after}.
slots:
modified_after: query.modified_after
method: generated
generated: '2026-09-26'
- target: $.paths['/api/ats/v1/activities'].post
update:
x-apievangelist-phrasing:
intent: Log a new activity on a candidate
effect: write
questions:
- How do I add a note or email record to a candidate's history in the ATS?
- Can I set whether a logged activity is private or visible to the whole team?
instructions:
- text: Log a {activity_type} activity on candidate {candidate} as user {user} with body {body} and visibility {visibility}.
slots:
activity_type: requestBody.activity_type
candidate: requestBody.candidate
user: requestBody.user
body: requestBody.body
visibility: requestBody.visibility
- text: 'Record a note titled {subject} for candidate {candidate} from user {user}: {body}, visibility {visibility}, type {activity_type}.'
slots:
subject: requestBody.subject
candidate: requestBody.candidate
user: requestBody.user
body: requestBody.body
visibility: requestBody.visibility
activity_type: requestBody.activity_type
method: generated
generated: '2026-09-26'
- target: $.paths['/api/ats/v1/activities/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one candidate activity by id
effect: read
questions:
- What does a single logged ATS activity record contain?
- Can I fetch one activity entry along with its raw source data?
instructions:
- text: Fetch activity {id}.
slots:
id: path.id
- text: Open activity record {id} and include the raw upstream payload.
slots:
id: path.id
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.