The Syncs API from Relevance AI — 5 operation(s) for syncs.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/relevance-ai-syncs-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
description: Relevance AI Endpoints
title: Relevance AI Endpoints Syncs API
version: latest
contact:
email: dev@tryrelevance.com
servers:
- url: /latest
security:
- AuthorizationHeader:
- Authorization
tags:
- name: Syncs
paths:
/syncs/items/{document_id}/get:
get:
summary: GetSyncs
tags:
- Syncs
description: '### Required permissions
> []'
operationId: GetSyncs
parameters:
- name: document_id
in: path
description: ID of document
required: true
schema:
type: string
maxLength: 240
pattern: ^[a-zd._-]+$
- in: query
name: select_fields
schema:
type: array
items:
type: string
description: Fields to include in the search results, empty array/list means all fields.
description: Fields to include in the search results, empty array/list means all fields.
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/GetSyncsOutput'
/syncs/items/{document_id}:
delete:
summary: DeleteSyncs
tags:
- Syncs
description: '### Required permissions
> []'
operationId: DeleteSyncs
parameters:
- name: document_id
in: path
description: ID of document
required: true
schema:
type: string
maxLength: 240
pattern: ^[a-zd._-]+$
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSyncsInput'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSyncsOutput'
/syncs/list:
post:
summary: ListSyncs
tags:
- Syncs
description: '### Required permissions
> []'
operationId: ListSyncs
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListSyncsInput'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ListSyncsOutput'
/syncs/items/{document_id}/upsert:
post:
summary: UpsertSyncs
tags:
- Syncs
description: '### Required permissions
> []'
operationId: UpsertSyncs
parameters:
- name: document_id
in: path
description: ID of document
required: true
schema:
type: string
maxLength: 240
pattern: ^[a-zd._-]+$
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertSyncsInput'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/UpsertSyncsOutput'
/syncs/items/{document_id}/trigger:
post:
summary: TriggerSync
tags:
- Syncs
description: '### Required permissions
> []'
operationId: TriggerSync
parameters:
- name: document_id
in: path
description: ID of document
required: true
schema:
type: string
maxLength: 240
pattern: ^[a-zd._-]+$
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TriggerSyncInput'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/TriggerSyncOutput'
components:
schemas:
UpsertSyncsInput:
type: object
properties:
data:
type: object
properties:
destination:
type: object
oneOf:
- properties:
type:
type: string
agent_id:
type: string
additionalProperties: false
required:
- agent_id
- properties:
type:
type: string
workforce_id:
type: string
additionalProperties: false
required:
- workforce_id
- type
- properties:
type:
type: string
knowledge_set_display_id:
type: string
additionalProperties: false
required:
- knowledge_set_display_id
- type
- properties:
type:
type: string
additionalProperties: false
required:
- type
run_method:
type: string
enum:
- automatic
- manual
default: automatic
contract:
type: object
properties:
time_zone:
type: string
description: operating timezone e.g. 'America/New_York'
start_of_workday:
type: string
description: time in format HH:mm:ss
end_of_workday:
type: string
description: time in format HH:mm:ss
max_tasks:
type: number
interval:
type: string
enum:
- hourly
- daily
active_week_days:
type: object
properties:
sunday:
type: boolean
monday:
type: boolean
tuesday:
type: boolean
wednesday:
type: boolean
thursday:
type: boolean
friday:
type: boolean
saturday:
type: boolean
additionalProperties: false
required:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
max_count:
type: object
properties:
number:
type: integer
interval:
type: string
enum:
- daily
required:
- number
- interval
additionalProperties: false
one_time_action:
type: boolean
description: If this property is true, then the specific time will be found on the sync item
prevent_triggering_if_conversation_active:
type: object
description: If this property is true, then the sync will not trigger if there is an active conversation
properties:
postpone_by:
description: postpone all upcoming trigger items in conversation by this amount of time in seconds
type: number
required:
- postpone_by
additionalProperties: false
metadata:
type: object
properties:
time_zone:
type: string
additionalProperties: false
additionalProperties: false
state:
type: object
properties:
last_item_process_time:
description: first item to process may not have this property set yet
status:
type: string
enum:
- creating
- in_progress
- complete
- paused
- cancelled
- failed
disable_incoming_items:
type: boolean
description: disabling incoming sync items from queueing and processing
count:
type: number
count_reset_time: {}
additionalProperties: false
last_sync_date_utc:
type: string
next_trigger_date_utc:
type: string
next_poll_date_utc:
type: string
config:
type: object
oneOf:
- type: object
properties:
type:
type: string
gmail:
type: object
properties:
oauth_account_id:
type: string
include_labels:
type: array
items:
type: string
exclude_emails:
type: array
items:
type: string
is_outreach_reply_only:
type: boolean
default: false
is_attachments_enabled:
type: boolean
default: false
recently_processed_ids:
type: array
items:
type: object
properties:
gmail_id:
type: string
required:
- gmail_id
additionalProperties: false
search:
type: string
thread_id_mapping:
type: string
required:
- oauth_account_id
additionalProperties: true
required:
- type
- gmail
additionalProperties: false
- type: object
properties:
type:
type: string
google_calendar:
type: object
properties:
oauth_account_id:
type: string
oauth_account_label:
type: string
calendar_id:
type: string
events:
type: object
properties:
updated_min_date:
type: string
description: Lower bound for event's last modification time (as a RFC3339 timestamp) to filter by.
notifications:
type: array
items:
type: object
properties:
timeOffset:
type: object
oneOf:
- properties:
unit:
type: string
enum:
- minutes
quantity:
type: integer
minimum: 0
maximum: 1440
direction:
type: string
enum:
- before
- after
required:
- unit
- quantity
- direction
- properties:
unit:
type: string
enum:
- hours
quantity:
type: integer
minimum: 0
maximum: 24
direction:
type: string
enum:
- before
- after
required:
- unit
- quantity
- direction
- properties:
unit:
type: string
enum:
- days
quantity:
type: integer
minimum: 0
maximum: 365
direction:
type: string
enum:
- before
- after
required:
- unit
- quantity
- direction
message:
type: object
properties:
type:
type: string
enum:
- raw
- custom
description: Type of the message
content:
type: string
description: Custom message content (optional if type is 'Whole payload')
required:
- type
additionalProperties: false
required:
- timeOffset
- message
additionalProperties: false
description: An array of notifications
required:
- notifications
required:
- oauth_account_id
- oauth_account_label
- calendar_id
- events
additionalProperties: true
required:
- type
- google_calendar
additionalProperties: false
- type: object
properties:
type:
type: string
teams_calendar:
type: object
properties:
oauth_account_id:
type: string
oauth_account_label:
type: string
calendar_id:
type: string
events:
type: object
properties:
updated_min_date:
type: string
description: Lower bound for event's last modification time (as a RFC3339 timestamp) to filter by.
watched_sensitivities:
type: array
items:
type: string
enum:
- normal
- private
description: Which Microsoft Graph event sensitivity levels should trigger the agent or workforce. Omit to watch every event (the default). The UI pre-selects all levels; removing one (e.g. 'private') stops events of that sensitivity from triggering. An empty array watches nothing.
notifications:
type: array
items:
type: object
properties:
timeOffset:
type: object
oneOf:
- properties:
unit:
type: string
enum:
- minutes
quantity:
type: integer
minimum: 0
maximum: 1440
direction:
type: string
enum:
- before
- after
required:
- unit
- quantity
- direction
- properties:
unit:
type: string
enum:
- hours
quantity:
type: integer
minimum: 0
maximum: 24
direction:
type: string
enum:
- before
- after
required:
- unit
- quantity
- direction
- properties:
unit:
type: string
enum:
- days
quantity:
type: integer
minimum: 0
maximum: 365
direction:
type: string
enum:
- before
- after
required:
- unit
- quantity
- direction
message:
type: object
properties:
type:
type: string
enum:
- raw
- custom
description: Type of the message
content:
type: string
description: Custom message content (optional if type is 'Whole payload')
required:
- type
additionalProperties: false
required:
- timeOffset
- message
additionalProperties: false
description: An array of notifications
required:
- oauth_account_id
- oauth_account_label
- calendar_id
- events
additionalProperties: true
required:
- type
- teams_calendar
additionalProperties: false
- type: object
properties:
type:
type: string
outlook:
type: object
properties:
oauth_account_id:
type: string
exclude_emails:
type: array
items:
type: string
is_outreach_reply_only:
type: boolean
default: false
is_attachments_enabled:
type: boolean
default: false
recently_processed_ids:
type: array
items:
type: object
properties:
outlook_id:
type: string
required:
- outlook_id
additionalProperties: false
search:
type: string
thread_id_mapping:
type: string
required:
- oauth_account_id
additionalProperties: true
required:
- type
- outlook
additionalProperties: false
- type: object
properties:
type:
type: string
hubspot:
type: object
properties:
oauth_account_id:
type: string
oauth_account_label:
type: string
include_labels:
type: array
items:
type: string
exclude_labels:
type: array
items:
type: string
labels:
type: array
items:
type: string
search:
type: string
additionalProperties: true
required:
- type
- hubspot
additionalProperties: false
- type: object
properties:
type:
type: string
unipile:
type: object
properties:
oauth_account_id:
type: string
oauth_account_label:
type: string
provider_user_id:
type: string
is_outreach_reply_only:
type: boolean
default: false
required:
- oauth_account_id
- oauth_account_label
- provider_user_id
additionalProperties: true
required:
- type
- unipile
additionalProperties: false
- type: object
properties:
type:
type: string
unipile:
type: object
properties:
oauth_account_id:
type: string
oauth_account_label:
type: string
provider_user_id:
type: string
is_outreach_reply_only:
type: boolean
default: false
required:
- oauth_account_id
- oauth_account_label
- provider_user_id
additionalProperties: true
required:
- type
- unipile
additionalProperties: false
- type: object
properties:
type:
type: string
unipile:
type: object
properties:
oauth_account_id:
type: string
oauth_account_label:
type: string
provider_user_id:
type: string
is_outreach_reply_only:
type: boolean
default: false
required:
- oauth_account_id
- oauth_account_label
- provider_user_id
additionalProperties: true
required:
- type
- unipile
additionalProperties: false
- type: object
properties:
type:
type: string
whatsapp:
type: object
properties:
oauth_account_id:
type: string
whatsapp_business_account_id:
type: string
required:
- whatsapp_business_account_id
additionalProperties: true
required:
- type
- whatsapp
additionalProperties: false
- type: object
properties:
type:
type: string
relevance_meeting_bot:
type: object
properties:
bot_id:
type: string
additionalProperties: true
required:
- type
- relevance_meeting_bot
additionalProperties: false
- type: object
properties:
type:
type: string
freshdesk:
type: object
properties:
oauth_account_id:
type: string
description: DEPRECATED
whitelist:
type: array
items:
type: object
properties:
source_object:
type: string
enum:
- ticket
default: ticket
source_properties:
type: array
items:
type: object
properties:
field_name:
type: string
whitelist_values:
type: array
items: {}
required:
- field_name
- whitelist_values
additionalProperties: false
required:
- source_object
- source_properties
additionalProperties: false
additionalProperties: false
required:
- type
- freshdesk
additionalProperties: false
- type: object
properties:
type:
type: string
salesforce:
type: object
properties:
oauth_account_id:
type: string
oauth_account_label:
type: string
salesforce_query:
type: string
last_processed_message_date_utc:
type: string
page_size:
type: number
default: 1000
sync_interval:
type: string
enum:
- minutely
- hourly
- daily
default: minutely
last_sync_date_utc:
type: string
dedupe_field:
type: string
enum:
- Email
- None
- Disabled
mapping:
type: object
properties:
unique_id:
type: string
description: jq path to unique input field for idempotency
thread_id:
type: string
description: jq path to input field for conversation threading
additionalProperties: false
task_creation_mode:
type: string
enum:
- existing_tasks_only
- new_and_existing_tasks
description: The task creation mode controls how tasks are created and appended to.
required:
- oauth_account_id
- salesforce_query
additionalProperties: false
required:
- type
- salesforce
additionalProperties: false
- type: object
properties:
type:
type: string
zoominfo:
type: object
properties:
oauth_account_id:
type: string
description: DEPRECATED
intent_topics:
type: array
items:
type: string
signal_score_min:
enum:
- 80
- 90
- 95
- 99
type: number
audience_strength_min:
enum:
- A
- B
- C
type: string
company_country:
type: string
# --- truncated at 32 KB (290 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/openapi/relevance-ai-syncs-api-openapi.yml