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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
|
Tags
Tags List
Get all tags
Python SDK
await pylon.tags.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": "tags",
"action": "list"
}'
Parameters
| Parameter Name |
Type |
Required |
Description |
cursor |
string |
No |
Cursor for pagination |
Records
| Field Name |
Type |
Description |
id |
string |
|
hex_color |
string | null |
|
object_type |
string | null |
|
value |
string | null |
|
Meta
| Field Name |
Type |
Description |
next_cursor |
string | null |
|
has_next_page |
boolean |
|
Tags Create
Create a new tag
Python SDK
await pylon.tags.create(
value="<str>",
object_type="<str>",
hex_color="<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": "tags",
"action": "create",
"params": {
"value": "<str>",
"object_type": "<str>",
"hex_color": "<str>"
}
}'
Parameters
| 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 |
Records
| Field Name |
Type |
Description |
data |
object |
|
data.id |
string |
|
data.hex_color |
string | null |
|
data.object_type |
string | null |
|
data.value |
string | null |
|
request_id |
string |
|
Tags Get
Get a tag by its ID
Python SDK
await pylon.tags.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": "tags",
"action": "get",
"params": {
"id": "<str>"
}
}'
Parameters
| Parameter Name |
Type |
Required |
Description |
id |
string |
Yes |
The ID of the tag |
Records
| Field Name |
Type |
Description |
id |
string |
|
hex_color |
string | null |
|
object_type |
string | null |
|
value |
string | null |
|
Tags Update
Update an existing tag by ID
Python SDK
await pylon.tags.update(
value="<str>",
hex_color="<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": "tags",
"action": "update",
"params": {
"value": "<str>",
"hex_color": "<str>",
"id": "<str>"
}
}'
Parameters
| Parameter Name |
Type |
Required |
Description |
value |
string |
No |
The tag value |
hex_color |
string |
|
|
…(truncated)