GitHub - truehostcloud/twentycrm-python-client · GitHub
Skip to content

truehostcloud/twentycrm-python-client

BranchesTags

Repository files navigation

twentycrm-api-client

Twenty is a customer relationship management (CRM) platform designed to help businesses manage their customer interactions and relationships effectively. The Twenty API provides programmatic access to the features and functionalities of the Twenty CRM platform, allowing developers to integrate and interact with the CRM data and operations.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: v0.1
  • Package version: 1.18.1
  • Generator version: 7.21.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import twentycrm_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import twentycrm_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import twentycrm_client
from twentycrm_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://crm.example.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = twentycrm_client.Configuration(
    host = "https://crm.example.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): bearerAuth
configuration = twentycrm_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with twentycrm_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = twentycrm_client.GeneralApi(api_client)

    try:
        # Get Open Api Schema
        api_response = api_instance.get_open_api_schema()
        print("The response of GeneralApi->get_open_api_schema:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling GeneralApi->get_open_api_schema: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://crm.example.com/rest

Class Method HTTP request Description
GeneralApi get_open_api_schema GET /open-api/core Get Open Api Schema
AttachmentsApi create_many_attachments POST /batch/attachments Create Many attachments
AttachmentsApi create_one_attachment POST /attachments Create One attachment
AttachmentsApi delete_many_attachments DELETE /attachments Delete Many attachments
AttachmentsApi delete_one_attachment DELETE /attachments/{id} Delete One attachment
AttachmentsApi find_attachment_duplicates POST /attachments/duplicates Find attachment Duplicates
AttachmentsApi find_many_attachments GET /attachments Find Many attachments
AttachmentsApi find_one_attachment GET /attachments/{id} Find One attachment
AttachmentsApi group_by_attachments GET /attachments/groupBy Group By attachments
AttachmentsApi merge_many_attachments PATCH /attachments/merge Merge Many attachments
AttachmentsApi restore_many_attachments PATCH /restore/attachments Restore Many attachments
AttachmentsApi restore_one_attachment PATCH /restore/attachments/{id} Restore One attachment
AttachmentsApi update_many_attachments PATCH /attachments Update Many attachments
AttachmentsApi update_one_attachment PATCH /attachments/{id} Update One attachment
BlocklistsApi create_many_blocklists POST /batch/blocklists Create Many blocklists
BlocklistsApi create_one_blocklist POST /blocklists Create One blocklist
BlocklistsApi delete_many_blocklists DELETE /blocklists Delete Many blocklists
BlocklistsApi delete_one_blocklist DELETE /blocklists/{id} Delete One blocklist
BlocklistsApi find_blocklist_duplicates POST /blocklists/duplicates Find blocklist Duplicates
BlocklistsApi find_many_blocklists GET /blocklists Find Many blocklists
BlocklistsApi find_one_blocklist GET /blocklists/{id} Find One blocklist
BlocklistsApi group_by_blocklists GET /blocklists/groupBy Group By blocklists
BlocklistsApi merge_many_blocklists PATCH /blocklists/merge Merge Many blocklists
BlocklistsApi restore_many_blocklists PATCH /restore/blocklists Restore Many blocklists
BlocklistsApi restore_one_blocklist PATCH /restore/blocklists/{id} Restore One blocklist
BlocklistsApi update_many_blocklists PATCH /blocklists Update Many blocklists
BlocklistsApi update_one_blocklist PATCH /blocklists/{id} Update One blocklist
CalendarChannelEventAssociationsApi create_many_calendar_channel_event_associations POST /batch/calendarChannelEventAssociations Create Many calendarChannelEventAssociations
CalendarChannelEventAssociationsApi create_one_calendar_channel_event_association POST /calendarChannelEventAssociations Create One calendarChannelEventAssociation
CalendarChannelEventAssociationsApi delete_many_calendar_channel_event_associations DELETE /calendarChannelEventAssociations Delete Many calendarChannelEventAssociations
CalendarChannelEventAssociationsApi delete_one_calendar_channel_event_association DELETE /calendarChannelEventAssociations/{id} Delete One calendarChannelEventAssociation
CalendarChannelEventAssociationsApi find_calendar_channel_event_association_duplicates POST /calendarChannelEventAssociations/duplicates Find calendarChannelEventAssociation Duplicates
CalendarChannelEventAssociationsApi find_many_calendar_channel_event_associations GET /calendarChannelEventAssociations Find Many calendarChannelEventAssociations
CalendarChannelEventAssociationsApi find_one_calendar_channel_event_association GET /calendarChannelEventAssociations/{id} Find One calendarChannelEventAssociation
CalendarChannelEventAssociationsApi group_by_calendar_channel_event_associations GET /calendarChannelEventAssociations/groupBy Group By calendarChannelEventAssociations
CalendarChannelEventAssociationsApi merge_many_calendar_channel_event_associations PATCH /calendarChannelEventAssociations/merge Merge Many calendarChannelEventAssociations
CalendarChannelEventAssociationsApi restore_many_calendar_channel_event_associations PATCH /restore/calendarChannelEventAssociations Restore Many calendarChannelEventAssociations
CalendarChannelEventAssociationsApi restore_one_calendar_channel_event_association PATCH /restore/calendarChannelEventAssociations/{id} Restore One calendarChannelEventAssociation
CalendarChannelEventAssociationsApi update_many_calendar_channel_event_associations PATCH /calendarChannelEventAssociations Update Many calendarChannelEventAssociations
CalendarChannelEventAssociationsApi update_one_calendar_channel_event_association PATCH /calendarChannelEventAssociations/{id} Update One calendarChannelEventAssociation
CalendarChannelsApi create_many_calendar_channels POST /batch/calendarChannels Create Many calendarChannels
CalendarChannelsApi create_one_calendar_channel POST /calendarChannels Create One calendarChannel
CalendarChannelsApi delete_many_calendar_channels DELETE /calendarChannels Delete Many calendarChannels
CalendarChannelsApi delete_one_calendar_channel DELETE /calendarChannels/{id} Delete One calendarChannel
CalendarChannelsApi find_calendar_channel_duplicates POST /calendarChannels/duplicates Find calendarChannel Duplicates
CalendarChannelsApi find_many_calendar_channels GET /calendarChannels Find Many calendarChannels
CalendarChannelsApi find_one_calendar_channel GET /calendarChannels/{id} Find One calendarChannel
CalendarChannelsApi group_by_calendar_channels GET /calendarChannels/groupBy Group By calendarChannels
CalendarChannelsApi merge_many_calendar_channels PATCH /calendarChannels/merge Merge Many calendarChannels
CalendarChannelsApi restore_many_calendar_channels PATCH /restore/calendarChannels Restore Many calendarChannels
CalendarChannelsApi restore_one_calendar_channel PATCH /restore/calendarChannels/{id} Restore One calendarChannel
CalendarChannelsApi update_many_calendar_channels PATCH /calendarChannels Update Many calendarChannels
CalendarChannelsApi update_one_calendar_channel PATCH /calendarChannels/{id} Update One calendarChannel
CalendarEventParticipantsApi create_many_calendar_event_participants POST /batch/calendarEventParticipants Create Many calendarEventParticipants
CalendarEventParticipantsApi create_one_calendar_event_participant POST /calendarEventParticipants Create One calendarEventParticipant
CalendarEventParticipantsApi delete_many_calendar_event_participants DELETE /calendarEventParticipants Delete Many calendarEventParticipants
CalendarEventParticipantsApi delete_one_calendar_event_participant DELETE /calendarEventParticipants/{id} Delete One calendarEventParticipant
CalendarEventParticipantsApi find_calendar_event_participant_duplicates POST /calendarEventParticipants/duplicates Find calendarEventParticipant Duplicates
CalendarEventParticipantsApi find_many_calendar_event_participants GET /calendarEventParticipants Find Many calendarEventParticipants
CalendarEventParticipantsApi find_one_calendar_event_participant GET /calendarEventParticipants/{id} Find One calendarEventParticipant
CalendarEventParticipantsApi group_by_calendar_event_participants GET /calendarEventParticipants/groupBy Group By calendarEventParticipants
CalendarEventParticipantsApi merge_many_calendar_event_participants PATCH /calendarEventParticipants/merge Merge Many calendarEventParticipants
CalendarEventParticipantsApi restore_many_calendar_event_participants PATCH /restore/calendarEventParticipants Restore Many calendarEventParticipants
CalendarEventParticipantsApi restore_one_calendar_event_participant PATCH /restore/calendarEventParticipants/{id} Restore One calendarEventParticipant
CalendarEventParticipantsApi update_many_calendar_event_participants PATCH /calendarEventParticipants Update Many calendarEventParticipants
CalendarEventParticipantsApi update_one_calendar_event_participant PATCH /calendarEventParticipants/{id} Update One calendarEventParticipant
CalendarEventsApi create_many_calendar_events POST /batch/calendarEvents Create Many calendarEvents
CalendarEventsApi create_one_calendar_event POST /calendarEvents Create One calendarEvent
CalendarEventsApi delete_many_calendar_events DELETE /calendarEvents Delete Many calendarEvents
CalendarEventsApi delete_one_calendar_event DELETE /calendarEvents/{id} Delete One calendarEvent
CalendarEventsApi find_calendar_event_duplicates POST /calendarEvents/duplicates Find calendarEvent Duplicates
CalendarEventsApi find_many_calendar_events GET /calendarEvents Find Many calendarEvents
CalendarEventsApi find_one_calendar_event GET /calendarEvents/{id} Find One calendarEvent
CalendarEventsApi group_by_calendar_events GET /calendarEvents/groupBy Group By calendarEvents
CalendarEventsApi merge_many_calendar_events PATCH /calendarEvents/merge Merge Many calendarEvents
CalendarEventsApi restore_many_calendar_events PATCH /restore/calendarEvents Restore Many calendarEvents
CalendarEventsApi restore_one_calendar_event PATCH /restore/calendarEvents/{id} Restore One calendarEvent
CalendarEventsApi update_many_calendar_events PATCH /calendarEvents Update Many calendarEvents
CalendarEventsApi update_one_calendar_event PATCH /calendarEvents/{id} Update One calendarEvent
CompaniesApi create_many_companies POST /batch/companies Create Many companies
CompaniesApi create_one_company POST /companies Create One company
CompaniesApi delete_many_companies DELETE /companies Delete Many companies
CompaniesApi delete_one_company DELETE /companies/{id} Delete One company
CompaniesApi find_company_duplicates POST /companies/duplicates Find company Duplicates
CompaniesApi find_many_companies GET /companies Find Many companies
CompaniesApi find_one_company GET /companies/{id} Find One company
CompaniesApi group_by_companies GET /companies/groupBy Group By companies
CompaniesApi merge_many_companies PATCH /companies/merge Merge Many companies
CompaniesApi restore_many_companies PATCH /restore/companies Restore Many companies
CompaniesApi restore_one_company PATCH /restore/companies/{id} Restore One company
CompaniesApi update_many_companies PATCH /companies Update Many companies
CompaniesApi update_one_company PATCH /companies/{id} Update One company
ConnectedAccountsApi create_many_connected_accounts POST /batch/connectedAccounts Create Many connectedAccounts
ConnectedAccountsApi create_one_connected_account POST /connectedAccounts Create One connectedAccount
ConnectedAccountsApi delete_many_connected_accounts DELETE /connectedAccounts Delete Many connectedAccounts
ConnectedAccountsApi delete_one_connected_account DELETE /connectedAccounts/{id} Delete One connectedAccount
ConnectedAccountsApi find_connected_account_duplicates POST /connectedAccounts/duplicates Find connectedAccount Duplicates
ConnectedAccountsApi find_many_connected_accounts GET /connectedAccounts Find Many connectedAccounts
ConnectedAccountsApi find_one_connected_account GET /connectedAccounts/{id} Find One connectedAccount
ConnectedAccountsApi group_by_connected_accounts GET /connectedAccounts/groupBy Group By connectedAccounts
ConnectedAccountsApi merge_many_connected_accounts PATCH /connectedAccounts/merge Merge Many connectedAccounts
ConnectedAccountsApi restore_many_connected_accounts PATCH /restore/connectedAccounts Restore Many connectedAccounts
ConnectedAccountsApi restore_one_connected_account PATCH /restore/connectedAccounts/{id} Restore One connectedAccount
ConnectedAccountsApi update_many_connected_accounts PATCH /connectedAccounts Update Many connectedAccounts
ConnectedAccountsApi update_one_connected_account PATCH /connectedAccounts/{id} Update One connectedAccount
DashboardsApi create_many_dashboards POST /batch/dashboards Create Many dashboards
DashboardsApi create_one_dashboard POST /dashboards Create One dashboard
DashboardsApi delete_many_dashboards DELETE /dashboards Delete Many dashboards
DashboardsApi delete_one_dashboard DELETE /dashboards/{id} Delete One dashboard
DashboardsApi duplicate_dashboard POST /dashboards/{id}/duplicate Duplicate a dashboard
DashboardsApi find_dashboard_duplicates POST /dashboards/duplicates Find dashboard Duplicates
DashboardsApi find_many_dashboards GET /dashboards Find Many dashboards
DashboardsApi find_one_dashboard GET /dashboards/{id} Find One dashboard
DashboardsApi group_by_dashboards GET /dashboards/groupBy Group By dashboards
DashboardsApi merge_many_dashboards PATCH /dashboards/merge Merge Many dashboards
DashboardsApi restore_many_dashboards PATCH /restore/dashboards Restore Many dashboards
DashboardsApi restore_one_dashboard PATCH /restore/dashboards/{id} Restore One dashboard
DashboardsApi update_many_dashboards PATCH /dashboards Update Many dashboards
DashboardsApi update_one_dashboard PATCH /dashboards/{id} Update One dashboard
FavoriteFoldersApi create_many_favorite_folders POST /batch/favoriteFolders Create Many favoriteFolders
FavoriteFoldersApi create_one_favorite_folder POST /favoriteFolders Create One favoriteFolder
FavoriteFoldersApi delete_many_favorite_folders DELETE /favoriteFolders Delete Many favoriteFolders
FavoriteFoldersApi delete_one_favorite_folder DELETE /favoriteFolders/{id} Delete One favoriteFolder
FavoriteFoldersApi find_favorite_folder_duplicates POST /favoriteFolders/duplicates Find favoriteFolder Duplicates
FavoriteFoldersApi find_many_favorite_folders GET /favoriteFolders Find Many favoriteFolders
FavoriteFoldersApi find_one_favorite_folder GET /favoriteFolders/{id} Find One favoriteFolder
FavoriteFoldersApi group_by_favorite_folders GET /favoriteFolders/groupBy Group By favoriteFolders
FavoriteFoldersApi merge_many_favorite_folders PATCH /favoriteFolders/merge Merge Many favoriteFolders
FavoriteFoldersApi restore_many_favorite_folders PATCH /restore/favoriteFolders Restore Many favoriteFolders
FavoriteFoldersApi restore_one_favorite_folder PATCH /restore/favoriteFolders/{id} Restore One favoriteFolder
FavoriteFoldersApi update_many_favorite_folders PATCH /favoriteFolders Update Many favoriteFolders
FavoriteFoldersApi update_one_favorite_folder PATCH /favoriteFolders/{id} Update One favoriteFolder
FavoritesApi create_many_favorites POST /batch/favorites Create Many favorites
FavoritesApi create_one_favorite POST /favorites Create One favorite
FavoritesApi delete_many_favorites DELETE /favorites Delete Many favorites
FavoritesApi delete_one_favorite DELETE /favorites/{id} Delete One favorite
FavoritesApi find_favorite_duplicates POST /favorites/duplicates Find favorite Duplicates
FavoritesApi find_many_favorites GET /favorites Find Many favorites
FavoritesApi find_one_favorite GET /favorites/{id} Find One favorite
FavoritesApi group_by_favorites GET /favorites/groupBy Group By favorites
FavoritesApi merge_many_favorites PATCH /favorites/merge Merge Many favorites
FavoritesApi restore_many_favorites PATCH /restore/favorites Restore Many favorites
FavoritesApi restore_one_favorite PATCH /restore/favorites/{id} Restore One favorite
FavoritesApi update_many_favorites PATCH /favorites Update Many favorites
FavoritesApi update_one_favorite PATCH /favorites/{id} Update One favorite
MessageChannelMessageAssociationsApi create_many_message_channel_message_associations POST /batch/messageChannelMessageAssociations Create Many messageChannelMessageAssociations
MessageChannelMessageAssociationsApi create_one_message_channel_message_association POST /messageChannelMessageAssociations Create One messageChannelMessageAssociation
MessageChannelMessageAssociationsApi delete_many_message_channel_message_associations DELETE /messageChannelMessageAssociations Delete Many messageChannelMessageAssociations
MessageChannelMessageAssociationsApi delete_one_message_channel_message_association DELETE /messageChannelMessageAssociations/{id} Delete One messageChannelMessageAssociation
MessageChannelMessageAssociationsApi find_many_message_channel_message_associations GET /messageChannelMessageAssociations Find Many messageChannelMessageAssociations
MessageChannelMessageAssociationsApi find_message_channel_message_association_duplicates POST /messageChannelMessageAssociations/duplicates Find messageChannelMessageAssociation Duplicates
MessageChannelMessageAssociationsApi find_one_message_channel_message_association GET /messageChannelMessageAssociations/{id} Find One messageChannelMessageAssociation
MessageChannelMessageAssociationsApi group_by_message_channel_message_associations GET /messageChannelMessageAssociations/groupBy Group By messageChannelMessageAssociations
MessageChannelMessageAssociationsApi merge_many_message_channel_message_associations PATCH /messageChannelMessageAssociations/merge Merge Many messageChannelMessageAssociations
MessageChannelMessageAssociationsApi restore_many_message_channel_message_associations PATCH /restore/messageChannelMessageAssociations Restore Many messageChannelMessageAssociations
MessageChannelMessageAssociationsApi restore_one_message_channel_message_association PATCH /restore/messageChannelMessageAssociations/{id} Restore One messageChannelMessageAssociation
MessageChannelMessageAssociationsApi update_many_message_channel_message_associations PATCH /messageChannelMessageAssociations Update Many messageChannelMessageAssociations
MessageChannelMessageAssociationsApi update_one_message_channel_message_association PATCH /messageChannelMessageAssociations/{id} Update One messageChannelMessageAssociation
MessageChannelsApi create_many_message_channels POST /batch/messageChannels Create Many messageChannels
MessageChannelsApi create_one_message_channel POST /messageChannels Create One messageChannel
MessageChannelsApi delete_many_message_channels DELETE /messageChannels Delete Many messageChannels
MessageChannelsApi delete_one_message_channel DELETE /messageChannels/{id} Delete One messageChannel
MessageChannelsApi find_many_message_channels GET /messageChannels Find Many messageChannels
MessageChannelsApi find_message_channel_duplicates POST /messageChannels/duplicates Find messageChannel Duplicates
MessageChannelsApi find_one_message_channel GET /messageChannels/{id} Find One messageChannel
MessageChannelsApi group_by_message_channels GET /messageChannels/groupBy Group By messageChannels
MessageChannelsApi merge_many_message_channels PATCH /messageChannels/merge Merge Many messageChannels
MessageChannelsApi restore_many_message_channels PATCH /restore/messageChannels Restore Many messageChannels
MessageChannelsApi restore_one_message_channel PATCH /restore/messageChannels/{id} Restore One messageChannel
MessageChannelsApi update_many_message_channels PATCH /messageChannels Update Many messageChannels
MessageChannelsApi update_one_message_channel PATCH /messageChannels/{id} Update One messageChannel
MessageFoldersApi create_many_message_folders POST /batch/messageFolders Create Many messageFolders
MessageFoldersApi create_one_message_folder POST /messageFolders Create One messageFolder
MessageFoldersApi delete_many_message_folders DELETE /messageFolders Delete Many messageFolders
MessageFoldersApi delete_one_message_folder DELETE /messageFolders/{id} Delete One messageFolder
MessageFoldersApi find_many_message_folders GET /messageFolders Find Many messageFolders
MessageFoldersApi find_message_folder_duplicates POST /messageFolders/duplicates Find messageFolder Duplicates
MessageFoldersApi find_one_message_folder GET /messageFolders/{id} Find One messageFolder
MessageFoldersApi group_by_message_folders GET /messageFolders/groupBy Group By messageFolders
MessageFoldersApi merge_many_message_folders PATCH /messageFolders/merge Merge Many messageFolders
MessageFoldersApi restore_many_message_folders PATCH /restore/messageFolders Restore Many messageFolders
MessageFoldersApi restore_one_message_folder PATCH /restore/messageFolders/{id} Restore One messageFolder
MessageFoldersApi update_many_message_folders PATCH /messageFolders Update Many messageFolders
MessageFoldersApi update_one_message_folder PATCH /messageFolders/{id} Update One messageFolder
MessageParticipantsApi create_many_message_participants POST /batch/messageParticipants Create Many messageParticipants
MessageParticipantsApi create_one_message_participant POST /messageParticipants Create One messageParticipant
MessageParticipantsApi delete_many_message_participants DELETE /messageParticipants Delete Many messageParticipants
MessageParticipantsApi delete_one_message_participant DELETE /messageParticipants/{id} Delete One messageParticipant
MessageParticipantsApi find_many_message_participants GET /messageParticipants Find Many messageParticipants
MessageParticipantsApi find_message_participant_duplicates POST /messageParticipants/duplicates Find messageParticipant Duplicates
MessageParticipantsApi find_one_message_participant GET /messageParticipants/{id} Find One messageParticipant
MessageParticipantsApi group_by_message_participants GET /messageParticipants/groupBy Group By messageParticipants
MessageParticipantsApi merge_many_message_participants PATCH /messageParticipants/merge Merge Many messageParticipants
MessageParticipantsApi restore_many_message_participants PATCH /restore/messageParticipants Restore Many messageParticipants
MessageParticipantsApi restore_one_message_participant PATCH /restore/messageParticipants/{id} Restore One messageParticipant
MessageParticipantsApi update_many_message_participants PATCH /messageParticipants Update Many messageParticipants
MessageParticipantsApi update_one_message_participant PATCH /messageParticipants/{id} Update One messageParticipant
MessageThreadsApi create_many_message_threads POST /batch/messageThreads Create Many messageThreads
MessageThreadsApi create_one_message_thread POST /messageThreads Create One messageThread
MessageThreadsApi delete_many_message_threads DELETE /messageThreads Delete Many messageThreads
MessageThreadsApi delete_one_message_thread DELETE /messageThreads/{id} Delete One messageThread
MessageThreadsApi find_many_message_threads GET /messageThreads Find Many messageThreads
MessageThreadsApi find_message_thread_duplicates POST /messageThreads/duplicates Find messageThread Duplicates
MessageThreadsApi find_one_message_thread GET /messageThreads/{id} Find One messageThread
MessageThreadsApi group_by_message_threads GET /messageThreads/groupBy Group By messageThreads
MessageThreadsApi merge_many_message_threads PATCH /messageThreads/merge Merge Many messageThreads
MessageThreadsApi restore_many_message_threads PATCH /restore/messageThreads Restore Many messageThreads
MessageThreadsApi restore_one_message_thread PATCH /restore/messageThreads/{id} Restore One messageThread
MessageThreadsApi update_many_message_threads PATCH /messageThreads Update Many messageThreads
MessageThreadsApi update_one_message_thread PATCH /messageThreads/{id} Update One messageThread
MessagesApi create_many_messages POST /batch/messages Create Many messages
MessagesApi create_one_message POST /messages Create One message
MessagesApi delete_many_messages DELETE /messages Delete Many messages
MessagesApi delete_one_message DELETE /messages/{id} Delete One message
MessagesApi find_many_messages GET /messages Find Many messages
MessagesApi find_message_duplicates POST /messages/duplicates Find message Duplicates
MessagesApi find_one_message GET /messages/{id} Find One message
MessagesApi group_by_messages GET /messages/groupBy Group By messages
MessagesApi merge_many_messages PATCH /messages/merge Merge Many messages
MessagesApi restore_many_messages PATCH /restore/messages Restore Many messages
MessagesApi restore_one_message PATCH /restore/messages/{id} Restore One message
MessagesApi update_many_messages PATCH /messages Update Many messages
MessagesApi update_one_message PATCH /messages/{id} Update One message
NoteTargetsApi create_many_note_targets POST /batch/noteTargets Create Many noteTargets
NoteTargetsApi create_one_note_target POST /noteTargets Create One noteTarget
NoteTargetsApi delete_many_note_targets DELETE /noteTargets Delete Many noteTargets
NoteTargetsApi delete_one_note_target DELETE /noteTargets/{id} Delete One noteTarget
NoteTargetsApi find_many_note_targets GET /noteTargets Find Many noteTargets
NoteTargetsApi find_note_target_duplicates POST /noteTargets/duplicates Find noteTarget Duplicates
NoteTargetsApi find_one_note_target GET /noteTargets/{id} Find One noteTarget
NoteTargetsApi group_by_note_targets GET /noteTargets/groupBy Group By noteTargets
NoteTargetsApi merge_many_note_targets PATCH /noteTargets/merge Merge Many noteTargets
NoteTargetsApi restore_many_note_targets PATCH /restore/noteTargets Restore Many noteTargets
NoteTargetsApi restore_one_note_target PATCH /restore/noteTargets/{id} Restore One noteTarget
NoteTargetsApi update_many_note_targets PATCH /noteTargets Update Many noteTargets
NoteTargetsApi update_one_note_target PATCH /noteTargets/{id} Update One noteTarget
NotesApi create_many_notes POST /batch/notes Create Many notes
NotesApi create_one_note POST /notes Create One note
NotesApi delete_many_notes DELETE /notes Delete Many notes
NotesApi delete_one_note DELETE /notes/{id} Delete One note
NotesApi find_many_notes GET /notes Find Many notes
NotesApi find_note_duplicates POST /notes/duplicates Find note Duplicates
NotesApi find_one_note GET /notes/{id} Find One note
NotesApi group_by_notes GET /notes/groupBy Group By notes
NotesApi merge_many_notes PATCH /notes/merge Merge Many notes
NotesApi restore_many_notes PATCH /restore/notes Restore Many notes
NotesApi restore_one_note PATCH /restore/notes/{id} Restore One note
NotesApi update_many_notes PATCH /notes Update Many notes
NotesApi update_one_note PATCH /notes/{id} Update One note
OpportunitiesApi create_many_opportunities POST /batch/opportunities Create Many opportunities
OpportunitiesApi create_one_opportunity POST /opportunities Create One opportunity
OpportunitiesApi delete_many_opportunities DELETE /opportunities Delete Many opportunities
OpportunitiesApi delete_one_opportunity DELETE /opportunities/{id} Delete One opportunity
OpportunitiesApi find_many_opportunities GET /opportunities Find Many opportunities
OpportunitiesApi find_one_opportunity GET /opportunities/{id} Find One opportunity
OpportunitiesApi find_opportunity_duplicates POST /opportunities/duplicates Find opportunity Duplicates
OpportunitiesApi group_by_opportunities GET /opportunities/groupBy Group By opportunities
OpportunitiesApi merge_many_opportunities PATCH /opportunities/merge Merge Many opportunities
OpportunitiesApi restore_many_opportunities PATCH /restore/opportunities Restore Many opportunities
OpportunitiesApi restore_one_opportunity PATCH /restore/opportunities/{id} Restore One opportunity
OpportunitiesApi update_many_opportunities PATCH /opportunities Update Many opportunities
OpportunitiesApi update_one_opportunity PATCH /opportunities/{id} Update One opportunity
PeopleApi create_many_people POST /batch/people Create Many people
PeopleApi create_one_person POST /people Create One person
PeopleApi delete_many_people DELETE /people Delete Many people
PeopleApi delete_one_person DELETE /people/{id} Delete One person
PeopleApi find_many_people GET /people Find Many people
PeopleApi find_one_person GET /people/{id} Find One person
PeopleApi find_person_duplicates POST /people/duplicates Find person Duplicates
PeopleApi group_by_people GET /people/groupBy Group By people
PeopleApi merge_many_people PATCH /people/merge Merge Many people
PeopleApi restore_many_people PATCH /restore/people Restore Many people
PeopleApi restore_one_person PATCH /restore/people/{id} Restore One person
PeopleApi update_many_people PATCH /people Update Many people
PeopleApi update_one_person PATCH /people/{id} Update One person
TaskTargetsApi create_many_task_targets POST /batch/taskTargets Create Many taskTargets
TaskTargetsApi create_one_task_target POST /taskTargets Create One taskTarget
TaskTargetsApi delete_many_task_targets DELETE /taskTargets Delete Many taskTargets
TaskTargetsApi delete_one_task_target DELETE /taskTargets/{id} Delete One taskTarget
TaskTargetsApi find_many_task_targets GET /taskTargets Find Many taskTargets
TaskTargetsApi find_one_task_target GET /taskTargets/{id} Find One taskTarget
TaskTargetsApi find_task_target_duplicates POST /taskTargets/duplicates Find taskTarget Duplicates
TaskTargetsApi group_by_task_targets GET /taskTargets/groupBy Group By taskTargets
TaskTargetsApi merge_many_task_targets PATCH /taskTargets/merge Merge Many taskTargets
TaskTargetsApi restore_many_task_targets PATCH /restore/taskTargets Restore Many taskTargets
TaskTargetsApi restore_one_task_target PATCH /restore/taskTargets/{id} Restore One taskTarget
TaskTargetsApi update_many_task_targets PATCH /taskTargets Update Many taskTargets
TaskTargetsApi update_one_task_target PATCH /taskTargets/{id} Update One taskTarget
TasksApi create_many_tasks POST /batch/tasks Create Many tasks
TasksApi create_one_task POST /tasks Create One task
TasksApi delete_many_tasks DELETE /tasks Delete Many tasks
TasksApi delete_one_task DELETE /tasks/{id} Delete One task
TasksApi find_many_tasks GET /tasks Find Many tasks
TasksApi find_one_task GET /tasks/{id} Find One task
TasksApi find_task_duplicates POST /tasks/duplicates Find task Duplicates
TasksApi group_by_tasks GET /tasks/groupBy Group By tasks
TasksApi merge_many_tasks PATCH /tasks/merge Merge Many tasks
TasksApi restore_many_tasks PATCH /restore/tasks Restore Many tasks
TasksApi restore_one_task PATCH /restore/tasks/{id} Restore One task
TasksApi update_many_tasks PATCH /tasks Update Many tasks
TasksApi update_one_task PATCH /tasks/{id} Update One task
TimelineActivitiesApi create_many_timeline_activities POST /batch/timelineActivities Create Many timelineActivities
TimelineActivitiesApi create_one_timeline_activity POST /timelineActivities Create One timelineActivity
TimelineActivitiesApi delete_many_timeline_activities DELETE /timelineActivities Delete Many timelineActivities
TimelineActivitiesApi delete_one_timeline_activity DELETE /timelineActivities/{id} Delete One timelineActivity
TimelineActivitiesApi find_many_timeline_activities GET /timelineActivities Find Many timelineActivities
TimelineActivitiesApi find_one_timeline_activity GET /timelineActivities/{id} Find One timelineActivity
TimelineActivitiesApi find_timeline_activity_duplicates POST /timelineActivities/duplicates Find timelineActivity Duplicates
TimelineActivitiesApi group_by_timeline_activities GET /timelineActivities/groupBy Group By timelineActivities
TimelineActivitiesApi merge_many_timeline_activities PATCH /timelineActivities/merge Merge Many timelineActivities
TimelineActivitiesApi restore_many_timeline_activities PATCH /restore/timelineActivities Restore Many timelineActivities
TimelineActivitiesApi restore_one_timeline_activity PATCH /restore/timelineActivities/{id} Restore One timelineActivity
TimelineActivitiesApi update_many_timeline_activities PATCH /timelineActivities Update Many timelineActivities
TimelineActivitiesApi update_one_timeline_activity PATCH /timelineActivities/{id} Update One timelineActivity
WorkflowAutomatedTriggersApi create_many_workflow_automated_triggers POST /batch/workflowAutomatedTriggers Create Many workflowAutomatedTriggers
WorkflowAutomatedTriggersApi create_one_workflow_automated_trigger POST /workflowAutomatedTriggers Create One workflowAutomatedTrigger
WorkflowAutomatedTriggersApi delete_many_workflow_automated_triggers DELETE /workflowAutomatedTriggers Delete Many workflowAutomatedTriggers
WorkflowAutomatedTriggersApi delete_one_workflow_automated_trigger DELETE /workflowAutomatedTriggers/{id} Delete One workflowAutomatedTrigger
WorkflowAutomatedTriggersApi find_many_workflow_automated_triggers GET /workflowAutomatedTriggers Find Many workflowAutomatedTriggers
WorkflowAutomatedTriggersApi find_one_workflow_automated_trigger GET /workflowAutomatedTriggers/{id} Find One workflowAutomatedTrigger
WorkflowAutomatedTriggersApi find_workflow_automated_trigger_duplicates POST /workflowAutomatedTriggers/duplicates Find workflowAutomatedTrigger Duplicates
WorkflowAutomatedTriggersApi group_by_workflow_automated_triggers GET /workflowAutomatedTriggers/groupBy Group By workflowAutomatedTriggers
WorkflowAutomatedTriggersApi merge_many_workflow_automated_triggers PATCH /workflowAutomatedTriggers/merge Merge Many workflowAutomatedTriggers
WorkflowAutomatedTriggersApi restore_many_workflow_automated_triggers PATCH /restore/workflowAutomatedTriggers Restore Many workflowAutomatedTriggers
WorkflowAutomatedTriggersApi restore_one_workflow_automated_trigger PATCH /restore/workflowAutomatedTriggers/{id} Restore One workflowAutomatedTrigger
WorkflowAutomatedTriggersApi update_many_workflow_automated_triggers PATCH /workflowAutomatedTriggers Update Many workflowAutomatedTriggers
WorkflowAutomatedTriggersApi update_one_workflow_automated_trigger PATCH /workflowAutomatedTriggers/{id} Update One workflowAutomatedTrigger
WorkflowRunsApi create_many_workflow_runs POST /batch/workflowRuns Create Many workflowRuns
WorkflowRunsApi create_one_workflow_run POST /workflowRuns Create One workflowRun
WorkflowRunsApi delete_many_workflow_runs DELETE /workflowRuns Delete Many workflowRuns
WorkflowRunsApi delete_one_workflow_run DELETE /workflowRuns/{id} Delete One workflowRun
WorkflowRunsApi find_many_workflow_runs GET /workflowRuns Find Many workflowRuns
WorkflowRunsApi find_one_workflow_run GET /workflowRuns/{id} Find One workflowRun
WorkflowRunsApi find_workflow_run_duplicates POST /workflowRuns/duplicates Find workflowRun Duplicates
WorkflowRunsApi group_by_workflow_runs GET /workflowRuns/groupBy Group By workflowRuns
WorkflowRunsApi merge_many_workflow_runs PATCH /workflowRuns/merge Merge Many workflowRuns
WorkflowRunsApi restore_many_workflow_runs PATCH /restore/workflowRuns Restore Many workflowRuns
WorkflowRunsApi restore_one_workflow_run PATCH /restore/workflowRuns/{id} Restore One workflowRun
WorkflowRunsApi update_many_workflow_runs PATCH /workflowRuns Update Many workflowRuns
WorkflowRunsApi update_one_workflow_run PATCH /workflowRuns/{id} Update One workflowRun
WorkflowVersionsApi create_many_workflow_versions POST /batch/workflowVersions Create Many workflowVersions
WorkflowVersionsApi create_one_workflow_version POST /workflowVersions Create One workflowVersion
WorkflowVersionsApi delete_many_workflow_versions DELETE /workflowVersions Delete Many workflowVersions
WorkflowVersionsApi delete_one_workflow_version DELETE /workflowVersions/{id} Delete One workflowVersion
WorkflowVersionsApi find_many_workflow_versions GET /workflowVersions Find Many workflowVersions
WorkflowVersionsApi find_one_workflow_version GET /workflowVersions/{id} Find One workflowVersion
WorkflowVersionsApi find_workflow_version_duplicates POST /workflowVersions/duplicates Find workflowVersion Duplicates
WorkflowVersionsApi group_by_workflow_versions GET /workflowVersions/groupBy Group By workflowVersions
WorkflowVersionsApi merge_many_workflow_versions PATCH /workflowVersions/merge Merge Many workflowVersions
WorkflowVersionsApi restore_many_workflow_versions PATCH /restore/workflowVersions Restore Many workflowVersions
WorkflowVersionsApi restore_one_workflow_version PATCH /restore/workflowVersions/{id} Restore One workflowVersion
WorkflowVersionsApi update_many_workflow_versions PATCH /workflowVersions Update Many workflowVersions
WorkflowVersionsApi update_one_workflow_version PATCH /workflowVersions/{id} Update One workflowVersion
WorkflowsApi create_many_workflows POST /batch/workflows Create Many workflows
WorkflowsApi create_one_workflow POST /workflows Create One workflow
WorkflowsApi delete_many_workflows DELETE /workflows Delete Many workflows
WorkflowsApi delete_one_workflow DELETE /workflows/{id} Delete One workflow
WorkflowsApi find_many_workflows GET /workflows Find Many workflows
WorkflowsApi find_one_workflow GET /workflows/{id} Find One workflow
WorkflowsApi find_workflow_duplicates POST /workflows/duplicates Find workflow Duplicates
WorkflowsApi group_by_workflows GET /workflows/groupBy Group By workflows
WorkflowsApi merge_many_workflows PATCH /workflows/merge Merge Many workflows
WorkflowsApi restore_many_workflows PATCH /restore/workflows Restore Many workflows
WorkflowsApi restore_one_workflow PATCH /restore/workflows/{id} Restore One workflow
WorkflowsApi update_many_workflows PATCH /workflows Update Many workflows
WorkflowsApi update_one_workflow PATCH /workflows/{id} Update One workflow
WorkspaceMembersApi create_many_workspace_members POST /batch/workspaceMembers Create Many workspaceMembers
WorkspaceMembersApi create_one_workspace_member POST /workspaceMembers Create One workspaceMember
WorkspaceMembersApi delete_many_workspace_members DELETE /workspaceMembers Delete Many workspaceMembers
WorkspaceMembersApi delete_one_workspace_member DELETE /workspaceMembers/{id} Delete One workspaceMember
WorkspaceMembersApi find_many_workspace_members GET /workspaceMembers Find Many workspaceMembers
WorkspaceMembersApi find_one_workspace_member GET /workspaceMembers/{id} Find One workspaceMember
WorkspaceMembersApi find_workspace_member_duplicates POST /workspaceMembers/duplicates Find workspaceMember Duplicates
WorkspaceMembersApi group_by_workspace_members GET /workspaceMembers/groupBy Group By workspaceMembers
WorkspaceMembersApi merge_many_workspace_members PATCH /workspaceMembers/merge Merge Many workspaceMembers
WorkspaceMembersApi restore_many_workspace_members PATCH /restore/workspaceMembers Restore Many workspaceMembers
WorkspaceMembersApi restore_one_workspace_member PATCH /restore/workspaceMembers/{id} Restore One workspaceMember
WorkspaceMembersApi update_many_workspace_members PATCH /workspaceMembers Update Many workspaceMembers
WorkspaceMembersApi update_one_workspace_member PATCH /workspaceMembers/{id} Update One workspaceMember

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (JWT)

Author

felix@twenty.com

About

No description, website, or topics provided.

Resources

Readme

License

AGPL-3.0 license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 1

v1.0.0 Latest
Mar 25, 2026

Packages

 
 
 

Contributors

Languages