← Tools Reference

Pylon

Pylon integration (Communication, Productivity). Imported from open-connector.

API key13 toolshttps://api.usepylon.com
GET
pylon_get_me
Fetch the Pylon organization associated with the API token.

/me

GET
pylon_list_issues
List Pylon issues within a required time range of up to 30 days.

/issues

4 parameters
ParamTypeRequiredDescription
start_timestringrequiredThe start time of the issue range in RFC3339 format.
end_timestringrequiredThe end time of the issue range in RFC3339 format.
cursorstringoptionalThe pagination cursor returned by a previous Pylon request.
limitintegeroptionalThe number of issues to fetch. Pylon accepts 0 through 20000.
GET
pylon_get_issue
Fetch one Pylon issue by ID or issue number.

/issues/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Pylon issue ID or issue number.
POST
pylon_create_issue
Create a Pylon issue with a title, HTML body, and requester or account context.

/issues

18 parameters
ParamTypeRequiredDescription
titlestringrequiredThe issue title.
body_htmlstringrequiredThe HTML content of the issue body.
account_idstringoptionalThe account this issue belongs to.
requester_idstringoptionalThe contact this issue is on behalf of.
requester_emailstringoptionalThe requester email address. Pylon creates a contact when none exists.
requester_namestringoptionalThe full name to use when creating a requester contact.
requester_avatar_urlstringoptionalThe requester avatar URL.
user_idstringoptionalThe internal user to attribute the first message to.
contact_idstringoptionalThe contact to attribute the first message to.
assignee_idstringoptionalThe user the issue should be assigned to.
team_idstringoptionalThe team the issue should be assigned to.
prioritystringoptionalThe issue priority.
tagsarrayoptionalTags to set on the Pylon object.
attachment_urlsarrayoptionalPublicly reachable attachment URLs for Pylon to fetch and attach.
author_unverifiedbooleanoptionalWhether the requester's identity has not been verified.
created_atstringoptionalThe issue creation timestamp in RFC3339 format.
custom_fieldsarrayoptionalCustom field values to apply to the Pylon object.
destination_metadataobjectoptionalDelivery metadata for a newly created Pylon issue.
PATCH
pylon_update_issue
Update mutable fields on one Pylon issue by ID or issue number.

/issues/{id}

11 parameters
ParamTypeRequiredDescription
idstringrequiredThe Pylon issue ID or issue number.
titlestringoptionalThe updated issue title.
statestringoptionalThe new issue state or custom status slug.
typestringoptionalThe updated issue type.
account_idstringoptionalThe account this issue belongs to.
requester_idstringoptionalThe contact this issue is on behalf of.
assignee_idstringoptionalThe user to assign this issue to. Use an empty string to remove the assignee.
team_idstringoptionalThe team to assign this issue to. Use an empty string to remove the team.
customer_portal_visiblebooleanoptionalWhether the issue should be visible in the customer portal.
tagsarrayoptionalTags to set on the Pylon object.
custom_fieldsarrayoptionalCustom field values to apply to the Pylon object.
GET
pylon_list_issue_messages
List messages, replies, and internal notes on one Pylon issue.

/issues/{id}/messages

3 parameters
ParamTypeRequiredDescription
idstringrequiredThe Pylon issue ID.
cursorstringoptionalThe pagination cursor returned by a previous Pylon request.
limitintegeroptionalThe number of messages to fetch. Pylon accepts values from 1 through 1000.
POST
pylon_create_issue_note
Create an internal note on a Pylon issue.

/issues/{id}/note

7 parameters
ParamTypeRequiredDescription
idstringrequiredThe Pylon issue ID.
body_htmlstringrequiredThe HTML body of the internal note.
attachment_urlsarrayoptionalPublicly reachable attachment URLs for Pylon to fetch and attach.
message_idstringoptionalThe internal note message ID to reply to.
thread_idstringoptionalThe internal thread ID to post the note to.
thread_namestringoptionalThe thread name to use if Pylon creates a new internal thread.
user_idstringoptionalThe internal user ID to post the note as.
GET
pylon_get_account
Fetch one Pylon account by account ID or external ID.

/accounts/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Pylon account ID or external ID.
POST
pylon_search_accounts
Search Pylon accounts with a filter and optional fuzzy text search.

/accounts/search

4 parameters
ParamTypeRequiredDescription
filterobjectrequiredA Pylon search filter object.
search_textstringoptionalFuzzy text search intersected with the provided account filter.
cursorstringoptionalThe pagination cursor returned by a previous Pylon request.
limitintegeroptionalThe number of accounts to fetch. Pylon accepts values from 1 through 999.
POST
pylon_create_account
Create a Pylon account.

/accounts

9 parameters
ParamTypeRequiredDescription
namestringrequiredThe account name.
account_typestringoptionalThe account type.
domainsarrayoptionalDomains for the account, without a leading scheme.
primary_domainstringoptionalThe primary domain, which must be included in domains when domains are provided.
external_idsarrayoptionalExternal IDs associated with the object.
tagsarrayoptionalTags to set on the Pylon object.
owner_idstringoptionalThe user ID of the account owner.
logo_urlstringoptionalThe square .png, .jpg, or .jpeg logo URL for the account.
custom_fieldsarrayoptionalCustom field values to apply to the Pylon object.
GET
pylon_get_contact
Fetch one Pylon contact by contact ID with optional paginated account context.

/contacts/{id}

3 parameters
ParamTypeRequiredDescription
idstringrequiredThe Pylon contact ID.
cursorstringoptionalThe pagination cursor returned by a previous Pylon request.
limitintegerrequiredThe number of related accounts to fetch. Pylon requires this query value and ac…
POST
pylon_search_contacts
Search Pylon contacts with a filter and optional fuzzy text search.

/contacts/search

4 parameters
ParamTypeRequiredDescription
filterobjectrequiredA Pylon search filter object.
search_textstringoptionalFuzzy text search intersected with the provided contact filter.
cursorstringoptionalThe pagination cursor returned by a previous Pylon request.
limitintegeroptionalThe number of contacts to fetch. Pylon accepts values from 1 through 999.
POST
pylon_create_contact
Create a Pylon contact.

/contacts

11 parameters
ParamTypeRequiredDescription
namestringrequiredThe contact name.
emailstringoptionalThe contact email address.
account_idstringoptionalThe account that this contact belongs to.
account_external_idstringoptionalThe external ID of the account that this contact belongs to.
avatar_urlstringoptionalThe square .png, .jpg, or .jpeg avatar URL for the contact.
external_idsarrayoptionalExternal IDs associated with the object.
phone_numbersarrayoptionalPhone numbers for the contact. Pylon expects digits only and at most 15 digits.
primary_phone_numberstringoptionalThe primary phone number, which must be in phone_numbers.
portal_rolestringoptionalThe portal role slug to assign to the contact.
portal_role_idstringoptionalThe custom portal role ID to assign to the contact.
custom_fieldsarrayoptionalCustom field values to apply to the Pylon object.