New: Kith open-sources its ATS.Read why
Skip to Content

Kith ATS API reference

Every query, mutation, object, input, enum and scalar of the Kith ATS API, generated from its schema.

Generated from the API's schema. Each page says what the schema says.

Queries

  • agent: One agent by id, or null when the workspace has no such agent.
  • agentBillingPeriods: The monthly charges for the agents the workspace has hired, newest first: the order they were opened in, latest at the top.
  • agentRun: One agent run by id, or null when the workspace has no such run. Poll it every few seconds while its status is PENDING or RUNNING.
  • agentRuns: The workspace's agent runs, newest first.
  • agents: The workspace's agents, oldest first.
  • call: One call by id, or null when the workspace has no such call. A call needs no live link to a candidate to be read, but one linked only to people not yet released to the workspace is null, as it is missing from calls.
  • callActions: The open call actions the reader can act on, newest first: those from their own calls, or everyone's when the workspace shares calls. An action to add someone to the rolodex is listed only while its unmatched call is waiting, and none about one of the workspace's own people is.
  • calls: The workspace's calls that are linked to at least one candidate, newest first.
  • candidate: One candidate by id, or null when the workspace has no such candidate.
  • candidateEmployments: Roles held by the workspace's candidates, oldest record first. For one candidate's own history, read Candidate.employments.
  • candidateFacts: Facts recorded about the workspace's candidates, oldest record first. For one candidate's own facts, read Candidate.facts.
  • candidateNotes: Notes on the workspace's candidates, oldest first. Use it to read notes across candidates: for one candidate's timeline, read Candidate.timelineNotes.
  • candidates: The workspace's candidates, oldest first. Candidates still in Kith ATS's own sourcing review are not included.
  • changeSuggestion: One change suggestion by id, or null when the workspace has none with it.
  • changeSuggestions: The AI's change suggestions, oldest first.
  • clientContact: One client contact by id, or null when the workspace has none with it.
  • clientContacts: The workspace's client contacts, oldest first.
  • clientUpdate: One client update by id, or null when there is none, it has not been sent, or it was withdrawn. NO_ACTING_USER when the request acts as no user: whether it is unread is a reader's own.
  • clientUpdates: The updates sent to the workspace, newest published first. NO_ACTING_USER when the request acts as no user: whether each is unread is a reader's own.
  • cliLoginRequest: A CLI login waiting for approval, by the code in the link the tool opened. Null when no request has that code, which includes one that was used up.
  • companies: The workspace's companies: clients, leads and candidates' employers alike, unless filter narrows them.
  • company: One company by id, or null when the workspace has no such company.
  • fieldDefinition: One workspace field by id, or null when the workspace has none with it.
  • fieldDefinitions: The fields the workspace keeps on its people, companies and opportunities, oldest first.
  • interview: An interview appointment by id, or null if the workspace cannot see it.
  • job: One job by id, or null when the workspace has no such job.
  • jobCandidate: One candidate's place on a job, by that place's id, or null when the workspace has none with it.
  • jobCandidates: Candidates' places on jobs across the workspace, oldest first. For one job's list, read Job.candidates.
  • jobs: The workspace's jobs, oldest first.
  • locateRecord: Which of the caller's own workspaces holds a job or a candidate. Use it when a link opens "not found": the record may belong to another workspace the person is in. It looks only inside workspaces the caller's sign-in belongs to, and answers with the workspace, never with the record. Give at least one id.
  • opportunities: The workspace's opportunities, oldest first.
  • opportunity: One opportunity by id, or null when the workspace has none with it.
  • people: The workspace's people, oldest first.
  • person: One person by id, or null when the workspace has no such person.
  • presentation: One presentation by id, or null when the workspace has none with it.
  • presentations: The candidates shown to buyers, newest recorded first.
  • pursuit: One pursuit by id, or null when the workspace has none with it. Use it to turn an old /business?lead=<id> link into its company.
  • pursuitByLinkedinUrl: The latest pursuit that goes through the person with this LinkedIn profile, or null when there is none. The browser extension asks this for the profile on screen.
  • recruitingTask: A recruiting task by id, or null when the workspace cannot see it.
  • recruitingTasks: Tasks the team created across the workspace’s jobs, in id order. Includes closed work.
  • relationshipSignals: The workspace's relationship signals, most urgent first, then most recently detected. Reading this records that the signals were shown to the reader, once for each signal, which a repeat read leaves as it is. A signal about a candidate not yet released to the workspace is not listed.
  • restrictions: The workspace's do-not-contact rules, oldest first.
  • teamCallActionCounts: How many call actions each member of the workspace has open, the member with most first. It gives counts only, so a member can be nudged without their calls being read. An action to add someone to the rolodex counts only while its unmatched call is waiting. The list holds the workspace's team, bounded by its size, and is empty when the team cannot be looked up.
  • touch: One touch by id, or null when the workspace has none with it.
  • touches: The workspace's messages, calls and meetings, newest recorded first. Filter by occurredFrom and occurredBefore to read them by when they happened.
  • unmatchedCall: One unmatched call by id, whatever its status, or null when there is none the reader may see: another member's call is not theirs to see unless the workspace shares calls.
  • unmatchedCalls: The unmatched calls waiting for the reader, newest first: their own, or everyone's when the workspace shares calls. Calls already attached or dismissed are not listed.
  • user: One user by id, or null when the workspace has no such user.
  • users: The workspace's team, in id order. It includes teammates who have been invited and have not signed in yet, so they can be given work, and people who have left whom records still name. The caller is viewer.user.
  • viewer: Who is making this request. Use it to check which workspace a key belongs to before writing.

Mutations

  • acceptChangeSuggestion: Accept a suggestion, as proposed or with an amended change, and apply it in the same write. If it cannot be applied nothing changes and the suggestion stays open (CHANGE_SUGGESTION_CANNOT_APPLY, with the reason). A decided suggestion is final: accepting one again in the same way returns it unchanged, and any other decision on it is CHANGE_SUGGESTION_ALREADY_DECIDED. Who decided is the caller.
  • activateFieldDefinition: Put a proposed or archived field into use, so it takes values. A workspace admin approves what the AI asked for: a member who is not one is refused (FORBIDDEN). Activating a field that is in use changes nothing.
  • addCandidateNote: Leave a note on a candidate, about a job or in general. The signed-in member is recorded as its author. Without a reference every call leaves another note. With requestId, a retry returns the note the first request wrote, with wasCreated false, and changes nothing; that id on another candidate's note is REQUEST_ID_IN_USE. With externalSource and externalId, a note is stored once in the same way; the pair on another candidate's note is EXTERNAL_ID_IN_USE. A note about a job needs the candidate on that job: CANDIDATE_NOT_ON_JOB otherwise. A note about a job, with words in it, on a candidate Kith delivered for that job is sent to Kith once the request is saved; a general note (no job) never goes to Kith, nor does a note brought in from Kith.
  • addCandidates: Add people to the workspace's candidates, 200 at most a call. Someone already among the workspace's candidates (the same LinkedIn profile, whatever the address's scheme, www., query or trailing slash; else the same email address in any case) is not added again: their record is returned unchanged, with wasCreated false. A person still in Kith ATS's own sourcing review is not a candidate of the workspace yet, so they are never matched, and a new record is added. Two entries of one call that name the same person are one record. Sending the same people again returns the same records. Each new candidate starts the workspace's agents for new candidates, once the request is saved.
  • addCandidatesToJob: Put candidates on a job, 200 at most. A new place is graded for the job straight away, and once the request has been saved the job's graded candidates are re-ranked against the caller's recruiter framework, when they have one. A candidate already on the job is not added again: their place is returned unchanged with wasAdded false, so repeating this adds nothing. A candidate given twice is added once.
  • addClientContact: Add a person the workspace deals with at a lead or a client. The company must be a lead or a client of the workspace, else NOT_FOUND. The person they are is matched by LinkedIn profile, then email. Every call adds another contact: a repeat is a second record, so look the person up first (clientContacts by email).
  • addCompany: Add a company to the workspace's leads or clients, or class one it already holds. The workspace keeps one company per name: a name it already has (matched as a job's hiring company is, ignoring case and spacing) is that company, never a second one, and a client is never made a lead. A repeat returns the same company with wasCreated false, and details sent as null or left out never overwrite what it holds.
  • addDefaultAgents: Give the workspace any of Kith ATS's standard agents it is missing. Agents it already has are left exactly as they are, so a second call adds nothing.
  • addOpportunityContact: Add a person to an opportunity in a role. One person can hold several roles: add them once for each. A person who already holds that role is returned as they are, with wasCreated false. A part is not edited: remove it and add another.
  • addRestriction: Put a do-not-contact rule on a person or a company. This records the rule: nothing in Kith ATS refuses a sourcing push or a draft because of it. Every call adds another rule, so two identical rules can exist.
  • approveCliLogin: Approve a CLI login, so the tool that asked is handed a key. A personal login makes the approver's own key, in the workspace they are signed in to. An operator login makes an Kith ATS operator key and is for Kith ATS staff signed in as themselves, not with a key; it is recorded in the staff audit log. A login is approved once: approving it again answers CLI_LOGIN_ALREADY_APPROVED and makes no key.
  • archiveCompany: Put a company's relationship away. It leaves everyday client lists; its contacts, jobs and pitch pages are kept and its jobs go on as they are. Archiving an archived company changes nothing, and keeps the day it was first archived. Only a company that is a lead or a client has a relationship to put away.
  • archiveFieldDefinition: Put a workspace field away. Its values are kept and it takes no new ones. Archiving an archived field changes nothing.
  • attachCandidateDocument: Attach an uploaded file to a candidate. Kith ATS reads it with the model, keeps a short summary, and fills in what it learns on the candidate: their title, company, location and years when read, their skills, certifications and languages added to their tags, and the file as their CV when it is one and they have none. The upload is prepared first (its key must have been issued to this workspace). An upload's key is attached once: a repeat naming the same key for the same candidate answers the document the first call made, with no fields changed, and reads nothing again; the key on another candidate's document is UPLOAD_IN_USE. The model's reading is paid for whatever becomes of the request.
  • attachUnmatchedCall: Attach an unmatched call to a candidate. It becomes a Call linked to them, stored once by its recorder and the recorder's own id, so a later sync of the same meeting lands on the same call. Any open call action raised from the unmatched call is marked done. Once the request has been saved, Kith ATS reads the call for facts about the candidate and checks it against the open jobs, both in the background: poll Call.roleCheck. Repeating this after a lost answer is refused with UNMATCHED_CALL_ALREADY_RESOLVED, which says which candidate it was attached to.
  • attachUnmatchedCallToNewCandidate: Attach an unmatched call to someone who is not a candidate yet. A candidate of the workspace with the email address given is used when there is one, and one is created otherwise, sourced from a call and owned by the caller; Kith ATS's agents hear of a new candidate once the request has been saved. Everything else is as attachUnmatchedCall. With an email, repeating this finds the same candidate, but the unmatched call is already resolved: UNMATCHED_CALL_ALREADY_RESOLVED.
  • captureRecruiterFramework: Build the caller's recruiter framework from their answers to the onboarding questions. Kith ATS reads the answers with a model and writes the framework, replacing any earlier one and keeping the answers. It takes a few seconds, and saves nothing if the model fails (UPSTREAM_FAILED: ask again). Every call builds again and raises version.
  • clearFieldValue: Remove a workspace field's value from one record. Clearing a value the record does not have is not an error: deletedFieldValueId is then null. The AI (setBy: AI) may not clear a value a person set (FIELD_VALUE_LOCKED).
  • completeCallAction: Mark a call action as done. Only an action the caller can see can be marked: their own, or anyone's when the workspace shares calls. Marking one that is already done leaves it as it is.
  • createApiKey: Make an API key for the caller, in the caller's workspace. The payload holds the key's secret, which is shown this once: store it straight away. Every call makes another key.
  • createChangeSuggestion: Propose a change for a person to accept, amend or dismiss, as the AI does. Nothing else changes. The suggestion is always open and undecided, whatever is sent. Every call makes another suggestion.
  • createExampleJob: Add Kith ATS's example job to the workspace, with twelve made-up candidates on it, graded. The job and the candidates are the caller's: sourced by them, and no agent or Connect event is fired for them, so made-up people are never sent to a workspace's webhooks. Each call adds another copy, with the same candidate emails.
  • createFieldDefinition: Add a field the workspace keeps on its people, companies or opportunities. It is in use at once. A key the workspace already has on that kind of record is refused (FIELD_KEY_IN_USE, naming the field that holds it), so a repeat is refused.
  • createJob: Create an open job. Each call creates a distinct opening, even for the same company and title. Creating the job announces job.created after commit.
  • createOpportunity: Open an opportunity with a company. It starts at IDENTIFIED unless a stage is given, and takes the company's default fee and guarantee for whatever it names none of. The stage it starts at is the first entry of its stage log. Every call opens another opportunity.
  • createPerson: Record a new person who is neither a candidate nor a client contact yet. It does not look for them first: query people by LinkedIn profile or email before adding, because every call makes another person. A LinkedIn profile or email another person already holds as a key stays theirs.
  • createRealtimeToken: Get a token to listen for live changes in the caller's workspace. The token allows subscribing to that workspace's channel and nothing else, with the caller as its client id. Ask for a new one each time the realtime client renews: every call makes a new token, so the answer must never be cached. NOT_CONFIGURED with service: REALTIME where realtime is switched off, and the app then falls back to polling.
  • createRecruitingTask: Assign a new task on a job. Each call creates a separate open task, even with the same title. A deadline records when the work is due.
  • createUploadUrl: An address to upload one file to, and the key to name it by afterwards. Send the bytes to uploadUrl with an HTTP PUT and the same content type, then pass key to the mutation the file is for. Every key is made under the caller's own workspace (a prospect's video under a platform prefix instead), whatever is sent. Nothing is stored until the file is sent: a repeat makes another key, and an address never used leaves nothing behind. NOT_CONFIGURED when file storage is not set up, FORBIDDEN for a staff purpose asked by anyone else, and INVALID_INPUT for a file type the purpose does not take.
  • deleteAgent: Delete an agent for good, with every run it made and every charge recorded for it. Workspace admins only. A hired agent must be terminated first (AGENT_STILL_HIRED). This cannot be undone. Deleting it a second time answers NOT_FOUND.
  • deleteApiKey: Delete one of the caller's own API keys. Programs using it stop working at once. A key may delete itself. Deleting it a second time answers NOT_FOUND.
  • deleteDemoWorkspace: Delete the caller's whole workspace, with everything in it and the caller's own key. Only a demo workspace, whose slug starts with demo-, can be deleted this way (NOT_A_DEMO_WORKSPACE), and slug must be that workspace's (WORKSPACE_MISMATCH). This cannot be undone. Once it has succeeded the key is gone, so a repeat is refused as unauthenticated.
  • deletePerson: Delete a person, with their touches, presentations, do-not-contact rules, field values and change suggestions. A candidate or client contact that was this person is kept and matched to a person afresh. Deleting a person a second time answers NOT_FOUND.
  • deletePresentation: Delete a presentation recorded by mistake. Deleting one a second time answers NOT_FOUND.
  • deleteTouch: Delete a recorded touch. Deleting one a second time answers NOT_FOUND.
  • dismissCallAction: Set a call action aside without doing it. Only an action the caller can see can be set aside: their own, or anyone's when the workspace shares calls. Setting aside one that already is leaves it as it is.
  • dismissChangeSuggestion: Dismiss a suggestion. Nothing is changed and the decision is final. Dismissing one already dismissed returns it unchanged; a suggestion accepted already is CHANGE_SUGGESTION_ALREADY_DECIDED.
  • dismissRelationshipSignal: Set a relationship signal aside as not useful. Dismissing one that already is leaves it as it is. A signal the caller cannot read is NOT_FOUND.
  • dismissUnmatchedCall: Dismiss an unmatched call as not a candidate call. It leaves the list, and any open call action raised from it is marked dismissed. Nothing else changes. Repeating it is refused with UNMATCHED_CALL_ALREADY_RESOLVED.
  • hireAgent: Hire an agent with instructions of the workspace's own, for a monthly charge. Workspace admins only. The first month's charge is opened straight away. Every call hires and charges again: do not repeat one whose answer was lost without reading agents first.
  • liftRestriction: Remove a do-not-contact rule. To end one on a day and keep the record, set until with updateRestriction instead. Removing one a second time answers NOT_FOUND.
  • linkCallToCandidate: Link a call to another candidate who was on it. The call's transcript is not copied, and nothing is worked out again: no facts are read from it and no role check is started. A link that was removed is restored, and one in force is left as it is, so repeating this answers the same link. The caller is recorded as having linked it.
  • markClientUpdatesSeen: Mark client updates as seen by the caller. A teammate's unread updates are not touched. The first time an update was seen is kept, so marking it again changes nothing. NO_ACTING_USER when the request acts as no user.
  • markClientUpdateUnread: Mark a client update as unread for the caller, to come back to it. A teammate's reading is not touched. Marking it again changes nothing. An update that is not a published one of the workspace is NOT_FOUND. NO_ACTING_USER when the request acts as no user.
  • markRelationshipSignalActedOn: Record that the suggested action on a relationship signal was taken. Open actionPath afterwards, when the signal has one. Recording it again leaves it as it is. A signal the caller cannot read is NOT_FOUND.
  • moveJobCandidate: Move a candidate to another stage of a job's pipeline. A decision the new stage contradicts is cleared (a No leaves with any stage but rejected, a Yes on going back to sourced or to rejected), and the move is logged in the place's history. Moving to DECLINED with a reason keeps the reason and clears any decision: the candidate withdrew, which is not the recruiter's call. To say Yes or No, use decideJobCandidate. Moving to the stage the place already holds changes nothing and starts nothing, so a repeat is harmless.
  • moveOpportunityStage: Give an opportunity a stage. Every stage it is given is written to its stage log with who gave it. Moving it to the stage it is at changes nothing and logs nothing: opportunityStageEvent is then null. A move to LOST needs a reason, from the input or already on the opportunity (LOST_REASON_REQUIRED).
  • openAgentBillingPeriods: Open this month's charge for every hired agent that has none covering today. Safe to call again: an agent already covered is left alone, so a second call the same day opens nothing.
  • proposeFieldDefinition: Ask for a field, as the AI does when it wants one. The field is PROPOSED and takes no values until a workspace admin activates it. A key the workspace already has on that kind of record is refused (FIELD_KEY_IN_USE), so a repeat is refused.
  • reassignRecruitingTask: Assign an open or snoozed job task to another active teammate. Its deadline and status stay with it. A closed task keeps its assignee.
  • recordCompanyRoles: Report the roles a company has open, as a job board or data provider lists them. Kith ATS keeps the company's current vacancies from these reports, and raises relationship signals from new ones: a new role at a company an open job targets, and three or more new go-to-market roles at a company the workspace knows. Reporting the same roles again, under the same source and externalKey, changes nothing and answers zeros. The work is done before the answer. 200 roles at most.
  • recordPresentation: Record that a candidate was shown to a buyer. Shown again is another record: this never merges with an earlier one, so a retried call records twice (deletePresentation removes a duplicate). A presentation for a job takes that job's opportunity unless it names another.
  • recordPresentationResponse: Record the buyer's answer to a candidate they were shown. An answer with no time is stamped now. The same answer twice leaves the presentation as it is.
  • recordTouch: Record a message, call or meeting with a person. A synced message is stored once: sending the same externalSource and externalId for the same person again returns the touch already stored, with wasCreated false, and changes nothing. A message to two people is two touches. Without an external id, every call records another touch.
  • removeOpportunityContact: Take a person's role in an opportunity away. Removing one a second time answers NOT_FOUND.
  • resolveRecruitingTask: Complete or dismiss an open or snoozed job task as a workspace member. Repeating its saved outcome with the current version preserves who closed it and when. A closed task cannot change outcome.
  • restoreCompany: Bring an archived relationship back. Restoring one that is not archived changes nothing.
  • runAgent: Run an agent on one or more candidates, optionally for a job, and wait for it. The agent may move a candidate's stage, grade them and leave notes. Returns one run for each candidate; a run that went wrong comes back with status FAILED, not as an error, and every run is kept whatever becomes of the rest of the request, so a caller that loses the answer can read agentRun. Every id is checked before anything runs, and so is the workspace's monthly limit: a request whose runs would pass it is refused whole. Every call runs the agent again.
  • scheduleInterview: Record a scheduled interview. Each call creates an appointment, including calls with identical details. The candidate keeps their stage. Scheduling here sends no invitation.
  • setCallVisibility: Choose who can see a synced call before it has been matched to a person. Workspace admins only. Choosing TEAM shows every teammate's unmatched calls to the whole workspace. It changes this one setting and nothing else. Setting the value it already has changes nothing.
  • setCandidatePerson: Say which person a candidate is, to correct a wrong match or to join two records of one human. The touches and presentations recorded against the candidate move with it. With no person given the server matches the candidate again. A candidate still in Kith ATS's sourcing review cannot be named: it is NOT_FOUND. The same input twice changes nothing.
  • setCatalogAgentEnabled: Switch one of Kith ATS's catalog agents on or off for the workspace. No catalog agent takes settings of its own. Setting the state it already has changes nothing.
  • setClientContactPerson: Say which person a client contact is, to correct a wrong match or to join two records of one human. The touches recorded against the contact move with it, and one the new person already holds from the same sync goes. With no person given the server matches the contact again. The same input twice changes nothing.
  • setFieldValue: Set a workspace field's value on one record. A record has one value per field: this replaces the one there. The same value again changes nothing, and the time it was set stays. A field that is proposed or archived takes no values (FIELD_NOT_ACTIVE), and a value a person set cannot be replaced by a write that says AI (FIELD_VALUE_LOCKED).
  • setJobOpportunity: Put a job under an opportunity, or take it out. The job's expected fee and the opportunity's total follow, as the database works them out. The same input twice leaves the same job. It writes only the job's opportunity and expected fee.
  • setJobStatus: Open, close or archive a job. An archived job keeps its pipeline, decisions and documents. The change is announced to the workspace's agents as a job update. A client company is made a client once one of its jobs leaves draft. Setting the status the job already has changes nothing.
  • snoozeRelationshipSignal: Put a relationship signal off until a later time. It needs attention again once that time passes. Snoozing it again sets the new time. A signal the caller cannot read, such as one about a candidate not yet released to the workspace, is NOT_FOUND.
  • startCallRoleCheck: Check a call against the workspace's open jobs. The work is done in the background, after this request has been saved: the answer comes back with the check PENDING, and Call.roleCheck is polled every couple of seconds until it is COMPLETED or FAILED. Without force, a finished check is answered as it is and nothing is started. Asking again while a check runs starts nothing more. The check runs on the model, so what it spends is kept whatever becomes of later requests.
  • startDictationSession: Open a live dictation session: a private room the caller's microphone streams to, which sends back the words as they are spoken. Each recording takes a session of its own, and every call makes a new room, so the answer must never be cached. NOT_CONFIGURED with service: VOICE where live dictation is not set up, and the app then uploads the recording instead (POST /api/voice/transcribe).
  • startPursuit: Start pursuing a company through a person there, from their LinkedIn profile: the company becomes a lead if it is nothing yet (a client stays a client), the person becomes its contact, and the pursuit is recorded, owned by the caller and at PURSUE. The contact is the workspace's contact with that profile, moved to this company if they were elsewhere and given the name and role sent. Asking again for the same person at the same company returns the pursuit already there, adding the advert if it is new. Needs a user to act as.
  • terminateAgent: End a hired agent's hire. Workspace admins only. It is switched off and no further months are charged. Its history is kept. Terminating it again changes nothing and keeps the first hire.terminatedAt.
  • unlinkCallFromCandidate: Take a call off a candidate. The call and its transcript are kept, and linking again restores the link. Taking off a call that was already taken off answers the same payload and writes nothing. NOT_FOUND for a call and candidate that were never linked.
  • updateClientContact: Change a client contact's details. A field left out is unchanged, and null clears it. The same input twice leaves the same contact.
  • updateCompany: Change a company's details, what it is to the workspace, its owner or its default terms. A field left out is unchanged. A name another company of the workspace already has (matched as addCompany matches it) is refused. The same input twice leaves the same company. The relationship and the status can only change on a company that is already a lead or a client.
  • updateFieldDefinition: Change a workspace field's label, type, choices or the AI's instruction. A field left out is unchanged. Its kind of record and its key never change. The same input twice leaves the same field.
  • updateInterview: Reschedule an appointment, change its status or record feedback. Cancelled appointments remain in the record and may be scheduled again. The candidate keeps their stage. Read again after a stale edit.
  • updateJobCandidateFollowUp: Record, reschedule or clear the next action on a candidate’s application, or record its submission time. Omitted fields keep their values. Use null to clear a field. This edit does not send a reminder or change the pipeline stage.
  • updateOpportunity: Change an opportunity's terms, owner, agreement, next step or summary. A field left out is unchanged, and null clears it. To change its stage, use moveOpportunityStage. New fee terms reprice the jobs under it. The same input twice leaves the same opportunity.
  • updatePerson: Change what is recorded about a person. A field left out is unchanged, and null clears it. Whether they are a candidate or a client contact is worked out by the server and is not an input. The same input twice leaves the same person.
  • updatePlacement: Change the offer and placement details of a candidate on a job: who owns the placement, the salary offered, the fee, their currency, the start day and the notes, and for a hired candidate the rest of the placement (when they accepted, the fee percentage, the guarantee, the invoice, who shares the credit, the referral and whether it fell through; NOT_A_PLACEMENT for a candidate not at the hired stage). A field left out is unchanged, and null clears it. The change is refused with STALE_VERSION when the placement's details have changed since the placementVersion given, so a blind repeat of a saved change is refused too; Kith ATS grading or re-ranking the place meanwhile is not a change to them.
  • updatePresentation: Correct a recorded presentation. A field left out is unchanged, and null clears it. The same input twice leaves the same presentation.
  • updateRecruiterFramework: Edit the caller's recruiter framework by hand. A part that is left out stays as it is. It creates the framework, at version 1, when the caller has none. The stored onboarding answers and capturedAt do not change. Every call raises version, whether or not anything differs.
  • updateRecruitingTask: Edit the title, instructions or deadline of an outstanding job task, or snooze and resume it. A snoozed task reappears in the actionable workload when its snooze expires.
  • updateRestriction: Change a do-not-contact rule's kind, reason, source or last day. A field left out is unchanged, and null clears it. To end a rule on a day and keep the record, set until. The same input twice leaves the same rule.
  • updateTouch: Correct a recorded touch. A field left out is unchanged, and null clears it. Who it was with is not corrected: delete it and record it again. The same input twice leaves the same touch.
  • updateWorkspaceBrand: Save how the workspace presents itself on the pages its clients see. It applies at once to links already sent. A value that is not valid is refused, never dropped. Saving the same values again changes nothing.

Objects

Inputs

Enums

Scalars

  • Boolean: The Boolean scalar type represents true or false.
  • Date: A calendar date with no time of day, as YYYY-MM-DD, such as 2026-11-16.
  • DateTime: A moment in time, as an ISO 8601 string in UTC, such as 2026-11-16T09:30:00.000Z.
  • Decimal: An exact decimal number written as a string, such as 85000.00 or 22.5, so money and percentages lose nothing in transit. Send it as a string, not a JSON number.
  • Float: The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
  • ID: The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
  • Int: The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
  • JSON: Any JSON value: text, a number, true or false, a list or an object. It is used only where the workspace, not Kith ATS, decides the shape, so read it defensively.
  • JSONObject: A JSON object whose keys are not fixed by this schema. It is used only where the shape is open by design, so read it defensively: a key may be missing.
  • String: The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.