twentycrm_client.CompaniesApi

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

Method	HTTP request	Description
create_many_companies	POST /batch/companies	Create Many companies
create_one_company	POST /companies	Create One company
delete_many_companies	DELETE /companies	Delete Many companies
delete_one_company	DELETE /companies/{id}	Delete One company
find_company_duplicates	POST /companies/duplicates	Find company Duplicates
find_many_companies	GET /companies	Find Many companies
find_one_company	GET /companies/{id}	Find One company
group_by_companies	GET /companies/groupBy	Group By companies
merge_many_companies	PATCH /companies/merge	Merge Many companies
restore_many_companies	PATCH /restore/companies	Restore Many companies
restore_one_company	PATCH /restore/companies/{id}	Restore One company
update_many_companies	PATCH /companies	Update Many companies
update_one_company	PATCH /companies/{id}	Update One company

create_many_companies

CreateManyCompanies201Response create_many_companies(company, depth=depth, upsert=upsert)

Create Many companies

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.company import Company
from twentycrm_client.models.create_many_companies201_response import CreateManyCompanies201Response
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.CompaniesApi(api_client)
    company = [twentycrm_client.Company()] # List[Company] | 
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)
    upsert = False # bool | If true, creates the object or updates it if it already exists. (optional) (default to False)

    try:
        # Create Many companies
        api_response = api_instance.create_many_companies(company, depth=depth, upsert=upsert)
        print("The response of CompaniesApi->create_many_companies:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->create_many_companies: %s\n" % e)

Parameters

Name	Type	Description	Notes
company	List[Company]
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]
upsert	bool	If true, creates the object or updates it if it already exists.	[optional] [default to False]

Return type

CreateManyCompanies201Response

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_one_company

CreateOneCompany201Response create_one_company(company, depth=depth, upsert=upsert)

Create One company

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.company import Company
from twentycrm_client.models.create_one_company201_response import CreateOneCompany201Response
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.CompaniesApi(api_client)
    company = twentycrm_client.Company() # Company | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)
    upsert = False # bool | If true, creates the object or updates it if it already exists. (optional) (default to False)

    try:
        # Create One company
        api_response = api_instance.create_one_company(company, depth=depth, upsert=upsert)
        print("The response of CompaniesApi->create_one_company:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->create_one_company: %s\n" % e)

Parameters

Name	Type	Description	Notes
company	Company	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]
upsert	bool	If true, creates the object or updates it if it already exists.	[optional] [default to False]

Return type

CreateOneCompany201Response

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_many_companies

DeleteManyCompanies200Response delete_many_companies(filter=filter, soft_delete=soft_delete)

Delete Many companies

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.delete_many_companies200_response import DeleteManyCompanies200Response
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.CompaniesApi(api_client)
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)
    soft_delete = False # bool | If true, soft deletes the objects. If false, objects are permanently deleted. (optional) (default to False)

    try:
        # Delete Many companies
        api_response = api_instance.delete_many_companies(filter=filter, soft_delete=soft_delete)
        print("The response of CompaniesApi->delete_many_companies:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->delete_many_companies: %s\n" % e)

Parameters

Name	Type	Description	Notes
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]
soft_delete	bool	If true, soft deletes the objects. If false, objects are permanently deleted.	[optional] [default to False]

Return type

DeleteManyCompanies200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_one_company

DeleteOneCompany200Response delete_one_company(id, soft_delete=soft_delete)

Delete One company

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.delete_one_company200_response import DeleteOneCompany200Response
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.CompaniesApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Object id.
    soft_delete = False # bool | If true, soft deletes the objects. If false, objects are permanently deleted. (optional) (default to False)

    try:
        # Delete One company
        api_response = api_instance.delete_one_company(id, soft_delete=soft_delete)
        print("The response of CompaniesApi->delete_one_company:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->delete_one_company: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID	Object id.
soft_delete	bool	If true, soft deletes the objects. If false, objects are permanently deleted.	[optional] [default to False]

Return type

DeleteOneCompany200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

find_company_duplicates

FindCompanyDuplicates200Response find_company_duplicates(find_company_duplicates_request, depth=depth)

Find company Duplicates

depth can be provided to request your company

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.find_company_duplicates200_response import FindCompanyDuplicates200Response
from twentycrm_client.models.find_company_duplicates_request import FindCompanyDuplicatesRequest
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.CompaniesApi(api_client)
    find_company_duplicates_request = twentycrm_client.FindCompanyDuplicatesRequest() # FindCompanyDuplicatesRequest | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Find company Duplicates
        api_response = api_instance.find_company_duplicates(find_company_duplicates_request, depth=depth)
        print("The response of CompaniesApi->find_company_duplicates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->find_company_duplicates: %s\n" % e)

Parameters

Name	Type	Description	Notes
find_company_duplicates_request	FindCompanyDuplicatesRequest	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

FindCompanyDuplicates200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

find_many_companies

FindManyCompanies200Response find_many_companies(order_by=order_by, filter=filter, limit=limit, depth=depth, starting_after=starting_after, ending_before=ending_before)

Find Many companies

order_by, filter, limit, depth, starting_after or ending_before can be provided to request your companies

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.find_many_companies200_response import FindManyCompanies200Response
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.CompaniesApi(api_client)
    order_by = 'createdAt' # str | Format: **field_name_1,field_name_2[DIRECTION_2]     Refer to the filter section at the top of the page for more details. (optional)
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)
    limit = 60 # int | Limits the number of objects returned. (optional) (default to 60)
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)
    starting_after = 'starting_after_example' # str | Returns objects starting after a specific cursor. You can find cursors in **startCursor** and **endCursor** in **pageInfo** in response data (optional)
    ending_before = 'ending_before_example' # str | Returns objects ending before a specific cursor. You can find cursors in **startCursor** and **endCursor** in **pageInfo** in response data (optional)

    try:
        # Find Many companies
        api_response = api_instance.find_many_companies(order_by=order_by, filter=filter, limit=limit, depth=depth, starting_after=starting_after, ending_before=ending_before)
        print("The response of CompaniesApi->find_many_companies:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->find_many_companies: %s\n" % e)

Parameters

Name	Type	Description	Notes
order_by	str	Format: **field_name_1,field_name_2[DIRECTION_2] Refer to the filter section at the top of the page for more details.	[optional]
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]
limit	int	Limits the number of objects returned.	[optional] [default to 60]
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]
starting_after	str	Returns objects starting after a specific cursor. You can find cursors in startCursor and endCursor in pageInfo in response data	[optional]
ending_before	str	Returns objects ending before a specific cursor. You can find cursors in startCursor and endCursor in pageInfo in response data	[optional]

Return type

FindManyCompanies200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

find_one_company

FindOneCompany200Response find_one_company(id, depth=depth)

Find One company

depth can be provided to request your company

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.find_one_company200_response import FindOneCompany200Response
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.CompaniesApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Object id.
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Find One company
        api_response = api_instance.find_one_company(id, depth=depth)
        print("The response of CompaniesApi->find_one_company:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->find_one_company: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID	Object id.
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

FindOneCompany200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

group_by_companies

GroupByCompanies200Response group_by_companies(group_by, filter=filter, order_by=order_by, limit=limit, view_id=view_id, aggregate=aggregate, include_records_sample=include_records_sample, order_by_for_records=order_by_for_records)

Group By companies

Groups companies by specified fields and optionally computes aggregate values for each group.

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.group_by_companies200_response import GroupByCompanies200Response
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.CompaniesApi(api_client)
    group_by = '[{\"updatedAt\": true}]' # str | Array of fields to group by. Each element can specify a field and optionally a subfield or granularity for date fields.
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)
    order_by = 'createdAt' # str | Format: **field_name_1,field_name_2[DIRECTION_2]     Refer to the filter section at the top of the page for more details. (optional)
    limit = 60 # int | Limits the number of objects returned. (optional) (default to 60)
    view_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | View ID to apply filters from. (optional)
    aggregate = '[\"countNotEmptyId\"]' # str | Array of aggregate operations to compute for each group. (optional)
    include_records_sample = False # bool | If true, includes a sample of records for each group in the response. (optional) (default to False)
    order_by_for_records = 'createdAt' # str | Order by clause for records within each group. Only applicable when include_records_sample is true. (optional)

    try:
        # Group By companies
        api_response = api_instance.group_by_companies(group_by, filter=filter, order_by=order_by, limit=limit, view_id=view_id, aggregate=aggregate, include_records_sample=include_records_sample, order_by_for_records=order_by_for_records)
        print("The response of CompaniesApi->group_by_companies:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->group_by_companies: %s\n" % e)

Parameters

Name	Type	Description	Notes
group_by	str	Array of fields to group by. Each element can specify a field and optionally a subfield or granularity for date fields.
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]
order_by	str	Format: **field_name_1,field_name_2[DIRECTION_2] Refer to the filter section at the top of the page for more details.	[optional]
limit	int	Limits the number of objects returned.	[optional] [default to 60]
view_id	UUID	View ID to apply filters from.	[optional]
aggregate	str	Array of aggregate operations to compute for each group.	[optional]
include_records_sample	bool	If true, includes a sample of records for each group in the response.	[optional] [default to False]
order_by_for_records	str	Order by clause for records within each group. Only applicable when include_records_sample is true.	[optional]

Return type

GroupByCompanies200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

merge_many_companies

MergeManyCompanies200Response merge_many_companies(merge_many_companies_request, depth=depth)

Merge Many companies

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.merge_many_companies200_response import MergeManyCompanies200Response
from twentycrm_client.models.merge_many_companies_request import MergeManyCompaniesRequest
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.CompaniesApi(api_client)
    merge_many_companies_request = twentycrm_client.MergeManyCompaniesRequest() # MergeManyCompaniesRequest | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Merge Many companies
        api_response = api_instance.merge_many_companies(merge_many_companies_request, depth=depth)
        print("The response of CompaniesApi->merge_many_companies:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->merge_many_companies: %s\n" % e)

Parameters

Name	Type	Description	Notes
merge_many_companies_request	MergeManyCompaniesRequest	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

MergeManyCompanies200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

restore_many_companies

RestoreManyCompanies200Response restore_many_companies(filter=filter, depth=depth)

Restore Many companies

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.restore_many_companies200_response import RestoreManyCompanies200Response
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.CompaniesApi(api_client)
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Restore Many companies
        api_response = api_instance.restore_many_companies(filter=filter, depth=depth)
        print("The response of CompaniesApi->restore_many_companies:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->restore_many_companies: %s\n" % e)

Parameters

Name	Type	Description	Notes
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

RestoreManyCompanies200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

restore_one_company

RestoreOneCompany200Response restore_one_company(id, depth=depth)

Restore One company

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.restore_one_company200_response import RestoreOneCompany200Response
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.CompaniesApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Object id.
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Restore One company
        api_response = api_instance.restore_one_company(id, depth=depth)
        print("The response of CompaniesApi->restore_one_company:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->restore_one_company: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID	Object id.
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

RestoreOneCompany200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_many_companies

UpdateManyCompanies200Response update_many_companies(company_for_update, depth=depth, filter=filter)

Update Many companies

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.company_for_update import CompanyForUpdate
from twentycrm_client.models.update_many_companies200_response import UpdateManyCompanies200Response
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.CompaniesApi(api_client)
    company_for_update = twentycrm_client.CompanyForUpdate() # CompanyForUpdate | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)
    filter = 'createdAt[gte]:\"2023-01-01\"' # str | Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.     For like/ilike, use % as a wildcard (e.g. %value% for substring match).     Refer to the filter section at the top of the page for more details. (optional)

    try:
        # Update Many companies
        api_response = api_instance.update_many_companies(company_for_update, depth=depth, filter=filter)
        print("The response of CompaniesApi->update_many_companies:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->update_many_companies: %s\n" % e)

Parameters

Name	Type	Description	Notes
company_for_update	CompanyForUpdate	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]
filter	str	Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.	[optional]

Return type

UpdateManyCompanies200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_one_company

UpdateOneCompany200Response update_one_company(id, company_for_update, depth=depth)

Update One company

Example

Bearer (JWT) Authentication (bearerAuth):

import twentycrm_client
from twentycrm_client.models.company_for_update import CompanyForUpdate
from twentycrm_client.models.update_one_company200_response import UpdateOneCompany200Response
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.CompaniesApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | Object id.
    company_for_update = twentycrm_client.CompanyForUpdate() # CompanyForUpdate | body
    depth = 1 # int | Determines the level of nested related objects to include in the response.     - 0: Primary object only     - 1: Primary object + direct relations (optional) (default to 1)

    try:
        # Update One company
        api_response = api_instance.update_one_company(id, company_for_update, depth=depth)
        print("The response of CompaniesApi->update_one_company:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CompaniesApi->update_one_company: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	UUID	Object id.
company_for_update	CompanyForUpdate	body
depth	int	Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations	[optional] [default to 1]

Return type

UpdateOneCompany200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-
400	Bad Request	-
401	Unauthorized	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

CompaniesApi.md

Latest commit

History

CompaniesApi.md

File metadata and controls

twentycrm_client.CompaniesApi

create_many_companies

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_one_company

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_many_companies

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_one_company

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_company_duplicates

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_many_companies

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_one_company

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

group_by_companies

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

merge_many_companies

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

restore_many_companies

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

restore_one_company

Example

Parameters