Pylon full reference

This is the full reference documentation for the Pylon agent connector.

Supported entities and actions

The Pylon connector supports the following entities and actions.

Entity	Actions
Issues	List, Create, Get, Update
Messages	List
Issue Notes	Create
Issue Threads	Create
Accounts	List, Create, Get, Update
Contacts	List, Create, Get, Update
Teams	List, Create, Get, Update
Tags	List, Create, Get, Update
Users	List, Get
Custom Fields	List, Get
Ticket Forms	List
User Roles	List
Tasks	Create, Update
Projects	Create, Update
Milestones	Create, Update
Articles	Create, Update
Collections	Create
Me	Get

Issues

Issues List

Get a list of issues within a time range

Python SDK

await pylon.issues.list(
    start_time="2025-01-01T00:00:00Z",
    end_time="2025-01-01T00:00:00Z"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "issues",
    "action": "list",
    "params": {
        "start_time": "2025-01-01T00:00:00Z",
        "end_time": "2025-01-01T00:00:00Z"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`start_time`	`string`	Yes	The start time (RFC3339) of the time range to get issues for.
`end_time`	`string`	Yes	The end time (RFC3339) of the time range to get issues for.
`cursor`	`string`	No	Cursor for pagination

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`account`	`object \| any`
`assignee`	`object \| any`
`attachment_urls`	`array \| null`
`author_unverified`	`boolean \| null`
`body_html`	`string \| null`
`business_hours_first_response_seconds`	`integer \| null`
`business_hours_resolution_seconds`	`integer \| null`
`chat_widget_info`	`object \| any`
`created_at`	`string \| null`
`csat_responses`	`array \| null`
`csat_responses[].comment`	`string \| null`
`csat_responses[].score`	`integer \| null`
`custom_fields`	`object \| null`
`customer_portal_visible`	`boolean \| null`
`external_issues`	`array \| null`
`external_issues[].external_id`	`string \| null`
`external_issues[].link`	`string \| null`
`external_issues[].source`	`string \| null`
`first_response_seconds`	`integer \| null`
`first_response_time`	`string \| null`
`latest_message_time`	`string \| null`
`link`	`string \| null`
`number`	`integer \| null`
`number_of_touches`	`integer \| null`
`requester`	`object \| any`
`resolution_seconds`	`integer \| null`
`resolution_time`	`string \| null`
`slack`	`object \| any`
`snoozed_until_time`	`string \| null`
`source`	`"slack" \| "microsoft_teams" \| "microsoft_teams_chat" \| "chat_widget" \| "email" \| "manual" \| "form" \| "discord" \| "whatsapp" \| "sms" \| "telegram" \| any`
`state`	`string \| null`
`tags`	`array \| null`
`team`	`object \| any`
`title`	`string \| null`
`type`	`"Conversation" \| "Ticket" \| any`

Meta

Field Name	Type	Description
`next_cursor`	`string \| null`
`has_next_page`	`boolean`

Issues Create

Create a new issue

Python SDK

await pylon.issues.create(
    title="<str>",
    body_html="<str>",
    priority="<str>",
    requester_email="<str>",
    requester_name="<str>",
    account_id="<str>",
    assignee_id="<str>",
    team_id="<str>",
    tags=[]
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "issues",
    "action": "create",
    "params": {
        "title": "<str>",
        "body_html": "<str>",
        "priority": "<str>",
        "requester_email": "<str>",
        "requester_name": "<str>",
        "account_id": "<str>",
        "assignee_id": "<str>",
        "team_id": "<str>",
        "tags": []
    }
}'

Parameters

Parameter Name	Type	Required	Description
`title`	`string`	Yes	The title of the issue
`body_html`	`string`	Yes	The HTML content of the body of the issue
`priority`	`string`	No	The priority of the issue (urgent, high, medium, low)
`requester_email`	`string`	No	The email of the requester
`requester_name`	`string`	No	The full name of the requester
`account_id`	`string`	No	The account that this issue belongs to
`assignee_id`	`string`	No	The user the issue should be assigned to
`team_id`	`string`	No	The ID of the team this issue should be assigned to
`tags`	`array<string>`	No	Tags to associate with the issue

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.account`	`object \| any`
`data.assignee`	`object \| any`
`data.attachment_urls`	`array \| null`
`data.author_unverified`	`boolean \| null`
`data.body_html`	`string \| null`
`data.business_hours_first_response_seconds`	`integer \| null`
`data.business_hours_resolution_seconds`	`integer \| null`
`data.chat_widget_info`	`object \| any`
`data.created_at`	`string \| null`
`data.csat_responses`	`array \| null`
`data.csat_responses[].comment`	`string \| null`
`data.csat_responses[].score`	`integer \| null`
`data.custom_fields`	`object \| null`
`data.customer_portal_visible`	`boolean \| null`
`data.external_issues`	`array \| null`
`data.external_issues[].external_id`	`string \| null`
`data.external_issues[].link`	`string \| null`
`data.external_issues[].source`	`string \| null`
`data.first_response_seconds`	`integer \| null`
`data.first_response_time`	`string \| null`
`data.latest_message_time`	`string \| null`
`data.link`	`string \| null`
`data.number`	`integer \| null`
`data.number_of_touches`	`integer \| null`
`data.requester`	`object \| any`
`data.resolution_seconds`	`integer \| null`
`data.resolution_time`	`string \| null`
`data.slack`	`object \| any`
`data.snoozed_until_time`	`string \| null`
`data.source`	`"slack" \| "microsoft_teams" \| "microsoft_teams_chat" \| "chat_widget" \| "email" \| "manual" \| "form" \| "discord" \| "whatsapp" \| "sms" \| "telegram" \| any`
`data.state`	`string \| null`
`data.tags`	`array \| null`
`data.team`	`object \| any`
`data.title`	`string \| null`
`data.type`	`"Conversation" \| "Ticket" \| any`
`request_id`	`string`

Issues Get

Get a single issue by ID

Python SDK

await pylon.issues.get(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "issues",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`id`	`string`	Yes	The ID of the issue

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`account`	`object \| any`
`assignee`	`object \| any`
`attachment_urls`	`array \| null`
`author_unverified`	`boolean \| null`
`body_html`	`string \| null`
`business_hours_first_response_seconds`	`integer \| null`
`business_hours_resolution_seconds`	`integer \| null`
`chat_widget_info`	`object \| any`
`created_at`	`string \| null`
`csat_responses`	`array \| null`
`csat_responses[].comment`	`string \| null`
`csat_responses[].score`	`integer \| null`
`custom_fields`	`object \| null`
`customer_portal_visible`	`boolean \| null`
`external_issues`	`array \| null`
`external_issues[].external_id`	`string \| null`
`external_issues[].link`	`string \| null`
`external_issues[].source`	`string \| null`
`first_response_seconds`	`integer \| null`
`first_response_time`	`string \| null`
`latest_message_time`	`string \| null`
`link`	`string \| null`
`number`	`integer \| null`
`number_of_touches`	`integer \| null`
`requester`	`object \| any`
`resolution_seconds`	`integer \| null`
`resolution_time`	`string \| null`
`slack`	`object \| any`
`snoozed_until_time`	`string \| null`
`source`	`"slack" \| "microsoft_teams" \| "microsoft_teams_chat" \| "chat_widget" \| "email" \| "manual" \| "form" \| "discord" \| "whatsapp" \| "sms" \| "telegram" \| any`
`state`	`string \| null`
`tags`	`array \| null`
`team`	`object \| any`
`title`	`string \| null`
`type`	`"Conversation" \| "Ticket" \| any`

Issues Update

Update an existing issue by ID

Python SDK

await pylon.issues.update(
    state="<str>",
    assignee_id="<str>",
    team_id="<str>",
    account_id="<str>",
    tags=[],
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "issues",
    "action": "update",
    "params": {
        "state": "<str>",
        "assignee_id": "<str>",
        "team_id": "<str>",
        "account_id": "<str>",
        "tags": [],
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`state`	`string`	No	The state of the issue (open, snoozed, closed)
`assignee_id`	`string`	No	The user the issue should be assigned to
`team_id`	`string`	No	The ID of the team this issue should be assigned to
`account_id`	`string`	No	The account that this issue belongs to
`tags`	`array<string>`	No	Tags to associate with the issue
`id`	`string`	Yes	The ID of the issue to update

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.account`	`object \| any`
`data.assignee`	`object \| any`
`data.attachment_urls`	`array \| null`
`data.author_unverified`	`boolean \| null`
`data.body_html`	`string \| null`
`data.business_hours_first_response_seconds`	`integer \| null`
`data.business_hours_resolution_seconds`	`integer \| null`
`data.chat_widget_info`	`object \| any`
`data.created_at`	`string \| null`
`data.csat_responses`	`array \| null`
`data.csat_responses[].comment`	`string \| null`
`data.csat_responses[].score`	`integer \| null`
`data.custom_fields`	`object \| null`
`data.customer_portal_visible`	`boolean \| null`
`data.external_issues`	`array \| null`
`data.external_issues[].external_id`	`string \| null`
`data.external_issues[].link`	`string \| null`
`data.external_issues[].source`	`string \| null`
`data.first_response_seconds`	`integer \| null`
`data.first_response_time`	`string \| null`
`data.latest_message_time`	`string \| null`
`data.link`	`string \| null`
`data.number`	`integer \| null`
`data.number_of_touches`	`integer \| null`
`data.requester`	`object \| any`
`data.resolution_seconds`	`integer \| null`
`data.resolution_time`	`string \| null`
`data.slack`	`object \| any`
`data.snoozed_until_time`	`string \| null`
`data.source`	`"slack" \| "microsoft_teams" \| "microsoft_teams_chat" \| "chat_widget" \| "email" \| "manual" \| "form" \| "discord" \| "whatsapp" \| "sms" \| "telegram" \| any`
`data.state`	`string \| null`
`data.tags`	`array \| null`
`data.team`	`object \| any`
`data.title`	`string \| null`
`data.type`	`"Conversation" \| "Ticket" \| any`
`request_id`	`string`

Messages

Messages List

Returns all messages on an issue (customer-facing replies and internal notes)

Python SDK

await pylon.messages.list(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "messages",
    "action": "list",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`id`	`string`	Yes	The ID of the issue to fetch messages for
`cursor`	`string`	No	Cursor for pagination

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`author`	`object \| any`
`email_info`	`object \| any`
`file_urls`	`array \| null`
`is_private`	`boolean \| null`
`message_html`	`string \| null`
`source`	`string \| null`
`thread_id`	`string \| null`
`timestamp`	`string \| null`

Meta

Field Name	Type	Description
`next_cursor`	`string \| null`
`has_next_page`	`boolean`

Issue Notes

Issue Notes Create

Create an internal note on an issue

Python SDK

await pylon.issue_notes.create(
    body_html="<str>",
    thread_id="<str>",
    message_id="<str>",
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "issue_notes",
    "action": "create",
    "params": {
        "body_html": "<str>",
        "thread_id": "<str>",
        "message_id": "<str>",
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`body_html`	`string`	Yes	The HTML content of the note
`thread_id`	`string`	No	The ID of the thread to add the note to
`message_id`	`string`	No	The ID of the message to add the note to
`id`	`string`	Yes	The ID of the issue to add a note to

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.body_html`	`string \| null`
`data.timestamp`	`string \| null`
`request_id`	`string`

Issue Threads

Issue Threads Create

Create a new thread on an issue

Python SDK

await pylon.issue_threads.create(
    name="<str>",
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "issue_threads",
    "action": "create",
    "params": {
        "name": "<str>",
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`name`	`string`	No	The name of the thread
`id`	`string`	Yes	The ID of the issue to create a thread on

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.name`	`string \| null`
`request_id`	`string`

Accounts

Accounts List

Get a list of accounts

Python SDK

await pylon.accounts.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "accounts",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Cursor for pagination

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`channels`	`array \| null`
`channels[].channel_id`	`string \| null`
`channels[].source`	`string \| null`
`channels[].is_primary`	`boolean \| null`
`created_at`	`string \| null`
`custom_fields`	`object \| null`
`domain`	`string \| null`
`domains`	`array \| null`
`external_ids`	`object \| null`
`is_disabled`	`boolean \| null`
`latest_customer_activity_time`	`string \| null`
`name`	`string \| null`
`owner`	`object \| any`
`primary_domain`	`string \| null`
`tags`	`array \| null`
`type`	`string \| null`

Meta

Field Name	Type	Description
`next_cursor`	`string \| null`
`has_next_page`	`boolean`

Accounts Create

Create a new account

Python SDK

await pylon.accounts.create(
    name="<str>",
    domains=[],
    primary_domain="<str>",
    owner_id="<str>",
    logo_url="<str>",
    tags=[]
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "accounts",
    "action": "create",
    "params": {
        "name": "<str>",
        "domains": [],
        "primary_domain": "<str>",
        "owner_id": "<str>",
        "logo_url": "<str>",
        "tags": []
    }
}'

Parameters

Parameter Name	Type	Required	Description
`name`	`string`	Yes	The name of the account
`domains`	`array<string>`	No	The domains of the account (e.g. stripe.com)
`primary_domain`	`string`	No	Must be in the list of domains. If there are any domains, there must be exactly one primary domain.
`owner_id`	`string`	No	The ID of the owner of the account
`logo_url`	`string`	No	The logo URL of the account. Must be a square .png, .jpg or .jpeg.
`tags`	`array<string>`	No	Tags to associate with the account

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.channels`	`array \| null`
`data.channels[].channel_id`	`string \| null`
`data.channels[].source`	`string \| null`
`data.channels[].is_primary`	`boolean \| null`
`data.created_at`	`string \| null`
`data.custom_fields`	`object \| null`
`data.domain`	`string \| null`
`data.domains`	`array \| null`
`data.external_ids`	`object \| null`
`data.is_disabled`	`boolean \| null`
`data.latest_customer_activity_time`	`string \| null`
`data.name`	`string \| null`
`data.owner`	`object \| any`
`data.primary_domain`	`string \| null`
`data.tags`	`array \| null`
`data.type`	`string \| null`
`request_id`	`string`

Accounts Get

Get a single account by ID

Python SDK

await pylon.accounts.get(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "accounts",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`id`	`string`	Yes	The ID of the account

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`channels`	`array \| null`
`channels[].channel_id`	`string \| null`
`channels[].source`	`string \| null`
`channels[].is_primary`	`boolean \| null`
`created_at`	`string \| null`
`custom_fields`	`object \| null`
`domain`	`string \| null`
`domains`	`array \| null`
`external_ids`	`object \| null`
`is_disabled`	`boolean \| null`
`latest_customer_activity_time`	`string \| null`
`name`	`string \| null`
`owner`	`object \| any`
`primary_domain`	`string \| null`
`tags`	`array \| null`
`type`	`string \| null`

Accounts Update

Update an existing account by ID

Python SDK

await pylon.accounts.update(
    name="<str>",
    domains=[],
    primary_domain="<str>",
    owner_id="<str>",
    logo_url="<str>",
    is_disabled=True,
    tags=[],
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "accounts",
    "action": "update",
    "params": {
        "name": "<str>",
        "domains": [],
        "primary_domain": "<str>",
        "owner_id": "<str>",
        "logo_url": "<str>",
        "is_disabled": True,
        "tags": [],
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`name`	`string`	No	The name of the account
`domains`	`array<string>`	No	Domains of the account. Must specify one domain as primary.
`primary_domain`	`string`	No	Must be in the list of domains. If there are any domains, there must be exactly one primary domain.
`owner_id`	`string`	No	The ID of the owner of the account. If empty string is passed in, the owner will be removed.
`logo_url`	`string`	No	Logo URL of the account
`is_disabled`	`boolean`	No	Whether the account is disabled
`tags`	`array<string>`	No	Tags to associate with the account
`id`	`string`	Yes	The ID of the account to update

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.channels`	`array \| null`
`data.channels[].channel_id`	`string \| null`
`data.channels[].source`	`string \| null`
`data.channels[].is_primary`	`boolean \| null`
`data.created_at`	`string \| null`
`data.custom_fields`	`object \| null`
`data.domain`	`string \| null`
`data.domains`	`array \| null`
`data.external_ids`	`object \| null`
`data.is_disabled`	`boolean \| null`
`data.latest_customer_activity_time`	`string \| null`
`data.name`	`string \| null`
`data.owner`	`object \| any`
`data.primary_domain`	`string \| null`
`data.tags`	`array \| null`
`data.type`	`string \| null`
`request_id`	`string`

Contacts

Contacts List

Get a list of contacts

Python SDK

await pylon.contacts.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "contacts",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Cursor for pagination

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`account`	`object \| any`
`avatar_url`	`string \| null`
`custom_fields`	`object \| null`
`email`	`string \| null`
`emails`	`array \| null`
`integration_user_ids`	`array \| null`
`integration_user_ids[].id`	`string \| null`
`integration_user_ids[].source`	`string \| null`
`name`	`string \| null`
`phone_numbers`	`array \| null`
`portal_role`	`string \| null`
`portal_role_id`	`string \| null`

Meta

Field Name	Type	Description
`next_cursor`	`string \| null`
`has_next_page`	`boolean`

Contacts Create

Create a new contact

Python SDK

await pylon.contacts.create(
    name="<str>",
    email="<str>",
    account_id="<str>",
    avatar_url="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "contacts",
    "action": "create",
    "params": {
        "name": "<str>",
        "email": "<str>",
        "account_id": "<str>",
        "avatar_url": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`name`	`string`	Yes	The name of the contact
`email`	`string`	No	The email address of the contact
`account_id`	`string`	No	The ID of the account to associate this contact with
`avatar_url`	`string`	No	The URL of the contact's avatar

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.account`	`object \| any`
`data.avatar_url`	`string \| null`
`data.custom_fields`	`object \| null`
`data.email`	`string \| null`
`data.emails`	`array \| null`
`data.integration_user_ids`	`array \| null`
`data.integration_user_ids[].id`	`string \| null`
`data.integration_user_ids[].source`	`string \| null`
`data.name`	`string \| null`
`data.phone_numbers`	`array \| null`
`data.portal_role`	`string \| null`
`data.portal_role_id`	`string \| null`
`request_id`	`string`

Contacts Get

Get a single contact by ID

Python SDK

await pylon.contacts.get(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "contacts",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`id`	`string`	Yes	The ID of the contact

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`account`	`object \| any`
`avatar_url`	`string \| null`
`custom_fields`	`object \| null`
`email`	`string \| null`
`emails`	`array \| null`
`integration_user_ids`	`array \| null`
`integration_user_ids[].id`	`string \| null`
`integration_user_ids[].source`	`string \| null`
`name`	`string \| null`
`phone_numbers`	`array \| null`
`portal_role`	`string \| null`
`portal_role_id`	`string \| null`

Contacts Update

Update an existing contact by ID

Python SDK

await pylon.contacts.update(
    name="<str>",
    email="<str>",
    account_id="<str>",
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "contacts",
    "action": "update",
    "params": {
        "name": "<str>",
        "email": "<str>",
        "account_id": "<str>",
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`name`	`string`	No	The name of the contact
`email`	`string`	No	The email address of the contact
`account_id`	`string`	No	The ID of the account to associate this contact with
`id`	`string`	Yes	The ID of the contact to update

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.account`	`object \| any`
`data.avatar_url`	`string \| null`
`data.custom_fields`	`object \| null`
`data.email`	`string \| null`
`data.emails`	`array \| null`
`data.integration_user_ids`	`array \| null`
`data.integration_user_ids[].id`	`string \| null`
`data.integration_user_ids[].source`	`string \| null`
`data.name`	`string \| null`
`data.phone_numbers`	`array \| null`
`data.portal_role`	`string \| null`
`data.portal_role_id`	`string \| null`
`request_id`	`string`

Teams

Teams List

Get a list of teams

Python SDK

await pylon.teams.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "teams",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Cursor for pagination

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`name`	`string \| null`
`users`	`array \| null`
`users[].email`	`string \| null`
`users[].id`	`string \| null`

Meta

Field Name	Type	Description
`next_cursor`	`string \| null`
`has_next_page`	`boolean`

Teams Create

Create a new team

Python SDK

await pylon.teams.create(
    name="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "teams",
    "action": "create",
    "params": {
        "name": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`name`	`string`	No	The name of the team

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.name`	`string \| null`
`data.users`	`array \| null`
`data.users[].email`	`string \| null`
`data.users[].id`	`string \| null`
`request_id`	`string`

Teams Get

Get a single team by ID

Python SDK

await pylon.teams.get(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "teams",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`id`	`string`	Yes	The ID of the team

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`name`	`string \| null`
`users`	`array \| null`
`users[].email`	`string \| null`
`users[].id`	`string \| null`

Teams Update

Update an existing team by ID

Python SDK

await pylon.teams.update(
    name="<str>",
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "teams",
    "action": "update",
    "params": {
        "name": "<str>",
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`name`	`string`	No	The name of the team
`id`	`string`	Yes	The ID of the team to update

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.name`	`string \| null`
`data.users`	`array \| null`
`data.users[].email`	`string \| null`
`data.users[].id`	`string \| null`
`request_id`	`string`

Parameter Name	Type	Required	Description
`value`	`string`	Yes	The tag value
`object_type`	`string`	Yes	The object type (issue, account, contact)
`hex_color`	`string`	No	The hex color code of the tag

Parameter Name	Type	Required	Description
`id`	`string`	Yes	The ID of the tag

Users

Users List

Get a list of users

Python SDK

await pylon.users.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "users",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Cursor for pagination

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`avatar_url`	`string \| null`
`email`	`string \| null`
`emails`	`array \| null`
`name`	`string \| null`
`role_id`	`string \| null`
`status`	`string \| null`

Meta

Field Name	Type	Description
`next_cursor`	`string \| null`
`has_next_page`	`boolean`

Users Get

Get a single user by ID

Python SDK

await pylon.users.get(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "users",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`id`	`string`	Yes	The ID of the user

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`avatar_url`	`string \| null`
`email`	`string \| null`
`emails`	`array \| null`
`name`	`string \| null`
`role_id`	`string \| null`
`status`	`string \| null`

Custom Fields

Custom Fields List

Get all custom fields for a given object type

Python SDK

await pylon.custom_fields.list(
    object_type="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "custom_fields",
    "action": "list",
    "params": {
        "object_type": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`object_type`	`"account" \| "issue" \| "contact"`	Yes	The object type of the custom fields. Can be "account", "issue", or "contact".
`cursor`	`string`	No	Cursor for pagination

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`created_at`	`string \| null`
`default_value`	`string \| null`
`default_values`	`array \| null`
`description`	`string \| null`
`is_read_only`	`boolean \| null`
`label`	`string \| null`
`number_metadata`	`object \| any`
`object_type`	`string \| null`
`select_metadata`	`object \| any`
`slug`	`string \| null`
`source`	`string \| null`
`type`	`string \| null`
`updated_at`	`string \| null`

Meta

Field Name	Type	Description
`next_cursor`	`string \| null`
`has_next_page`	`boolean`

Custom Fields Get

Get a custom field by its ID

Python SDK

await pylon.custom_fields.get(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "custom_fields",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`id`	`string`	Yes	The ID of the custom field

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`created_at`	`string \| null`
`default_value`	`string \| null`
`default_values`	`array \| null`
`description`	`string \| null`
`is_read_only`	`boolean \| null`
`label`	`string \| null`
`number_metadata`	`object \| any`
`object_type`	`string \| null`
`select_metadata`	`object \| any`
`slug`	`string \| null`
`source`	`string \| null`
`type`	`string \| null`
`updated_at`	`string \| null`

Ticket Forms

Ticket Forms List

Get a list of ticket forms

Python SDK

await pylon.ticket_forms.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "ticket_forms",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Cursor for pagination

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`description_html`	`string \| null`
`fields`	`array \| null`
`fields[].description_html`	`string \| null`
`fields[].name`	`string \| null`
`fields[].slug`	`string \| null`
`fields[].type`	`string \| null`
`is_public`	`boolean \| null`
`name`	`string \| null`
`slug`	`string \| null`
`url`	`string \| null`

Meta

Field Name	Type	Description
`next_cursor`	`string \| null`
`has_next_page`	`boolean`

User Roles

User Roles List

Get a list of all user roles

Python SDK

await pylon.user_roles.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "user_roles",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`cursor`	`string`	No	Cursor for pagination

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`name`	`string \| null`
`slug`	`string \| null`

Meta

Field Name	Type	Description
`next_cursor`	`string \| null`
`has_next_page`	`boolean`

Tasks

Tasks Create

Create a new task

Python SDK

await pylon.tasks.create(
    title="<str>",
    body_html="<str>",
    status="<str>",
    assignee_id="<str>",
    project_id="<str>",
    milestone_id="<str>",
    due_date="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "tasks",
    "action": "create",
    "params": {
        "title": "<str>",
        "body_html": "<str>",
        "status": "<str>",
        "assignee_id": "<str>",
        "project_id": "<str>",
        "milestone_id": "<str>",
        "due_date": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`title`	`string`	Yes	The title of the task
`body_html`	`string`	No	The body HTML of the task
`status`	`string`	No	The status of the task (not_started, in_progress, completed)
`assignee_id`	`string`	No	The assignee ID for the task
`project_id`	`string`	No	The project ID for the task
`milestone_id`	`string`	No	The milestone ID for the task
`due_date`	`string`	No	The due date for the task (RFC3339)

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.title`	`string \| null`
`data.body_html`	`string \| null`
`data.status`	`string \| null`
`data.assignee_id`	`string \| null`
`data.project_id`	`string \| null`
`data.milestone_id`	`string \| null`
`data.due_date`	`string \| null`
`data.created_at`	`string \| null`
`data.updated_at`	`string \| null`
`request_id`	`string`

Tasks Update

Update an existing task by ID

Python SDK

await pylon.tasks.update(
    title="<str>",
    body_html="<str>",
    status="<str>",
    assignee_id="<str>",
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "tasks",
    "action": "update",
    "params": {
        "title": "<str>",
        "body_html": "<str>",
        "status": "<str>",
        "assignee_id": "<str>",
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`title`	`string`	No	The title of the task
`body_html`	`string`	No	The body HTML of the task
`status`	`string`	No	The status of the task (not_started, in_progress, completed)
`assignee_id`	`string`	No	The assignee ID for the task
`id`	`string`	Yes	The ID of the task to update

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.title`	`string \| null`
`data.body_html`	`string \| null`
`data.status`	`string \| null`
`data.assignee_id`	`string \| null`
`data.project_id`	`string \| null`
`data.milestone_id`	`string \| null`
`data.due_date`	`string \| null`
`data.created_at`	`string \| null`
`data.updated_at`	`string \| null`
`request_id`	`string`

Projects

Projects Create

Create a new project

Python SDK

await pylon.projects.create(
    name="<str>",
    account_id="<str>",
    description_html="<str>",
    start_date="<str>",
    end_date="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "projects",
    "action": "create",
    "params": {
        "name": "<str>",
        "account_id": "<str>",
        "description_html": "<str>",
        "start_date": "<str>",
        "end_date": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`name`	`string`	Yes	The name of the project
`account_id`	`string`	Yes	The account ID for the project
`description_html`	`string`	No	The HTML description of the project
`start_date`	`string`	No	The start date of the project (RFC3339)
`end_date`	`string`	No	The end date of the project (RFC3339)

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.name`	`string \| null`
`data.description_html`	`string \| null`
`data.account_id`	`string \| null`
`data.owner_id`	`string \| null`
`data.start_date`	`string \| null`
`data.end_date`	`string \| null`
`data.is_archived`	`boolean \| null`
`data.created_at`	`string \| null`
`data.updated_at`	`string \| null`
`request_id`	`string`

Projects Update

Update an existing project by ID

Python SDK

await pylon.projects.update(
    name="<str>",
    description_html="<str>",
    is_archived=True,
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "projects",
    "action": "update",
    "params": {
        "name": "<str>",
        "description_html": "<str>",
        "is_archived": True,
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`name`	`string`	No	The name of the project
`description_html`	`string`	No	The HTML description of the project
`is_archived`	`boolean`	No	Whether the project is archived
`id`	`string`	Yes	The ID of the project to update

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.name`	`string \| null`
`data.description_html`	`string \| null`
`data.account_id`	`string \| null`
`data.owner_id`	`string \| null`
`data.start_date`	`string \| null`
`data.end_date`	`string \| null`
`data.is_archived`	`boolean \| null`
`data.created_at`	`string \| null`
`data.updated_at`	`string \| null`
`request_id`	`string`

Milestones

Milestones Create

Create a new milestone

Python SDK

await pylon.milestones.create(
    name="<str>",
    project_id="<str>",
    due_date="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "milestones",
    "action": "create",
    "params": {
        "name": "<str>",
        "project_id": "<str>",
        "due_date": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`name`	`string`	Yes	The name of the milestone
`project_id`	`string`	Yes	The project ID for the milestone
`due_date`	`string`	No	The due date of the milestone (RFC3339)

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.name`	`string \| null`
`data.project_id`	`string \| null`
`data.due_date`	`string \| null`
`data.created_at`	`string \| null`
`data.updated_at`	`string \| null`
`request_id`	`string`

Milestones Update

Update an existing milestone by ID

Python SDK

await pylon.milestones.update(
    name="<str>",
    due_date="<str>",
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "milestones",
    "action": "update",
    "params": {
        "name": "<str>",
        "due_date": "<str>",
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`name`	`string`	No	The name of the milestone
`due_date`	`string`	No	The due date of the milestone (RFC3339)
`id`	`string`	Yes	The ID of the milestone to update

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.name`	`string \| null`
`data.project_id`	`string \| null`
`data.due_date`	`string \| null`
`data.created_at`	`string \| null`
`data.updated_at`	`string \| null`
`request_id`	`string`

Articles

Articles Create

Create a new article in a knowledge base

Python SDK

await pylon.articles.create(
    title="<str>",
    body_html="<str>",
    author_user_id="<str>",
    slug="<str>",
    is_published=True,
    kb_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "articles",
    "action": "create",
    "params": {
        "title": "<str>",
        "body_html": "<str>",
        "author_user_id": "<str>",
        "slug": "<str>",
        "is_published": True,
        "kb_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`title`	`string`	Yes	The title of the article
`body_html`	`string`	Yes	The HTML body of the article
`author_user_id`	`string`	Yes	The ID of the user attributed as the author
`slug`	`string`	No	The slug of the article
`is_published`	`boolean`	No	Whether the article should be published
`kb_id`	`string`	Yes	The ID of the knowledge base

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.title`	`string \| null`
`data.body_html`	`string \| null`
`data.slug`	`string \| null`
`data.is_published`	`boolean \| null`
`data.author_user_id`	`string \| null`
`data.created_at`	`string \| null`
`data.updated_at`	`string \| null`
`request_id`	`string`

Articles Update

Update an existing article in a knowledge base

Python SDK

await pylon.articles.update(
    title="<str>",
    body_html="<str>",
    kb_id="<str>",
    article_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "articles",
    "action": "update",
    "params": {
        "title": "<str>",
        "body_html": "<str>",
        "kb_id": "<str>",
        "article_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`title`	`string`	No	The title of the article
`body_html`	`string`	No	The HTML body of the article
`kb_id`	`string`	Yes	The ID of the knowledge base
`article_id`	`string`	Yes	The ID of the article to update

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.title`	`string \| null`
`data.body_html`	`string \| null`
`data.slug`	`string \| null`
`data.is_published`	`boolean \| null`
`data.author_user_id`	`string \| null`
`data.created_at`	`string \| null`
`data.updated_at`	`string \| null`
`request_id`	`string`

Collections

Collections Create

Create a new collection in a knowledge base

Python SDK

await pylon.collections.create(
    title="<str>",
    description="<str>",
    slug="<str>",
    kb_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "collections",
    "action": "create",
    "params": {
        "title": "<str>",
        "description": "<str>",
        "slug": "<str>",
        "kb_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`title`	`string`	Yes	The title of the collection
`description`	`string`	No	The description of the collection
`slug`	`string`	No	The slug of the collection
`kb_id`	`string`	Yes	The ID of the knowledge base

Response Schema

Records

Field Name	Type	Description
`data`	`object`
`data.id`	`string`
`data.title`	`string \| null`
`data.description`	`string \| null`
`data.slug`	`string \| null`
`data.created_at`	`string \| null`
`request_id`	`string`

Me

Me Get

Get the currently authenticated user

Python SDK

await pylon.me.get()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "me",
    "action": "get"
}'

Response Schema

Records

Field Name	Type	Description
`id`	`string`
`avatar_url`	`string \| null`
`email`	`string \| null`
`emails`	`array \| null`
`name`	`string \| null`
`role_id`	`string \| null`
`status`	`string \| null`

Supported entities and actions​

Issues​

Issues List​

Python SDK​

API​

Parameters​

Records​

Meta​

Issues Create​

Python SDK​

API​

Parameters​

Records​

Issues Get​

Python SDK​

API​

Parameters​

Records​

Issues Update​

Python SDK​

API​

Parameters​

Records​

Messages​

Messages List​

Python SDK​

API​

Parameters​

Records​

Meta​

Issue Notes​

Issue Notes Create​

Python SDK​

API​

Parameters​

Records​

Issue Threads​

Issue Threads Create​

Python SDK​

API​

Parameters​

Records​

Accounts​

Accounts List​

Python SDK​

API​

Parameters​

Records​

Meta​

Accounts Create​

Python SDK​

API​

Parameters​

Records​

Accounts Get​

Python SDK​

API​

Parameters​

Records​

Accounts Update​

Python SDK​

API​

Parameters​

Records​

Contacts​

Contacts List​

Python SDK​

API​

Parameters​

Records​

Meta​

Contacts Create​

Python SDK​

API​

Parameters​

Records​

Contacts Get​

Python SDK​

API​

Parameters​

Supported entities and actions

Issues

Issues List

Python SDK

API

Parameters

Records

Meta

Issues Create

Python SDK

API

Parameters

Records

Issues Get

Python SDK

API

Parameters

Records

Issues Update

Python SDK

API

Parameters

Records

Messages

Messages List

Python SDK

API

Parameters

Records

Meta

Issue Notes

Issue Notes Create

Python SDK

API

Parameters

Records

Issue Threads

Issue Threads Create

Python SDK

API

Parameters

Records

Accounts

Accounts List

Python SDK

API

Parameters

Records

Meta

Accounts Create

Python SDK

API

Parameters

Records

Accounts Get

Python SDK

API

Parameters

Records

Accounts Update

Python SDK

API

Parameters

Records

Contacts

Contacts List

Python SDK

API

Parameters

Records

Meta

Contacts Create

Python SDK

API

Parameters

Records

Contacts Get

Python SDK

API

Parameters