Jump to Content
Product Guide
Recruitment AI Overview
API Reference
Status
Home
Product Guide
API Reference
Product Updates
v2.0
v3.0
Product Guide
Recruitment AI Overview
API Reference
Status
Product Updates
App Log In
API Reference
Product Updates
App Log In
v3.0
API Reference
Document API - Splitting
Search
JUMP TO
Affinda API
Quick Start
Organization API - Organization
Get list of all organizations
get
Create a new organization
post
Get detail of an organization
get
Update an organization
patch
Delete an organization
delete
Organization API - Invitation
Get list of all invitations
get
Create a new invitation
post
Get detail of an invitation
get
Update an invitation
patch
Delete an invitation
delete
Get detail of an invitation by token
get
Respond to an invitation
patch
Organization API - Membership
Get list of all organization memberships
get
Get detail of an organization membership
get
Update an organization membership
patch
Delete an organization membership
delete
Organization API - Users
Get list of all API users
get
Create an API user
post
Get specific API user
get
Update an API user
patch
Delete an API user
delete
Regenerate API key for an API user
post
Document API - Workspace
Get list of all workspaces
get
Create a workspace
post
Get specific workspace
get
Update a workspace
patch
Delete a workspace
delete
Get usage by workspace
get
Get list of all workspace memberships
get
Create a workspace membership
post
Get specific workspace membership
get
Delete a workspace membership
delete
Document API - Collection
Get list of all collections
get
Create a collection
post
Get specific collection
get
Update a collection
patch
Delete a collection
delete
Get data field for a collection assosciated with a data point.
get
Update data field for a collection assosciated with a data point.
patch
Get usage by collection
get
Document API - Document
Get list of all documents
get
Upload a document for parsing
post
Get specific document
get
Update a document
patch
Delete a document
delete
Update a document's data
post
Get redacted document
get
Get list of all validation results
get
Create a validation result
post
Get specific validation result
get
Update a validation result
patch
Delete a validation result
delete
Batch create validation results
post
Batch delete validation results
post
Document API - Splitting
Document API - Tag
Add a tag to documents
post
Remove a tag from documents
post
Get list of all tags
get
Create a tag
post
Get specific tag
get
Update a tag
patch
Delete an tag
delete
Document API - Document Type
List document types
get
Create a document type
post
Get a document type
get
Update a document type
patch
Delete a document type
delete
Document API - Data Point
Get list of all data points
get
Get specific data point
get
Update a data point
patch
Delete a data point
delete
Get list of data point choices
get
Create a data point choice
post
Get specific data point choice
get
Update a data point choice
patch
Delete a data point choice
delete
Replace choices of a data point
post
Document API - Mapping Data Sources
Create a mapping data source
post
List mapping data sources
get
Get specific mapping data source
get
Delete specific mapping data source
delete
List values for a mapping data source
get
Replace values for a mapping data source
put
Add value for a mapping data source
post
Get specific mapping data source value
get
Update specific mapping data source value
put
Delete specific mapping data source value
delete
Create a mapping
post
List mappings
get
Get specific mapping
get
Delete specific mapping
delete
Update specific mapping
patch
Document API - Annotation
Get list of all annotations
get
Create a annotation
post
Get specific annotation
get
Update an annotation
patch
Delete an annotation
delete
Batch create annotations
post
Batch update annotations
post
Batch delete annotations
post
Webhook API
Get list of all resthook subscriptions
get
Create a resthook subscription
post
Get specific resthook subscription
get
Update a resthook subscription
patch
Delete a resthook subscription
delete
Activate a resthook subscription
post
Search & Match API - Indexing
Get list of all indexes
get
Create a new index
post
Update an index
patch
Delete an index
delete
Get indexed documents for a specific index
get
Index a new document
post
Delete an indexed document
delete
Re-index a document
post
Search & Match API - Searching
List occupation groups
get
Search through parsed resumes
post
Get search result of specific resume
post
Match a single resume and job description
get
Get job title suggestions based on provided job title(s)
get
Get skill suggestions based on provided skill(s)
get
Search through parsed job descriptions
post
Get search result of specific job description
post
API Specification
API Versions
Client Libraries
Search & Match API - Embedding
Get the config for the logged in user's embeddable resume search tool
get
Update the config for the logged in user's embeddable resume search tool
patch
Create a signed URL for the embeddable resume search tool
post
Get the config for the logged in user's embeddable job description search tool
get
Update the config for the logged in user's embeddable job description search tool
patch
Create a signed URL for the embeddable job description search tool
post
Powered by
Document API - Splitting
