# Grid Squid Version: 1.0.0 ## Servers ``` https://{yourDomain}.gridsquid.io ``` Variables: - `yourDomain`: Domain ID assigned by the service provider Default: "demo" ## Security ### JWTtoken Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Grid Squid](https://gridsquid.redocly.app/_spec/openapi.yaml) ## Companies group of users pointing to a specific CRM instance ### Get company - [GET /companies/{company_id}](https://gridsquid.redocly.app/openapi/companies/get_company_companies__company_id__get.md) ### Delete company - [DELETE /companies/{company_id}](https://gridsquid.redocly.app/openapi/companies/delete_company_companies__company_id__delete.md) ### Update company - [PATCH /companies/{company_id}](https://gridsquid.redocly.app/openapi/companies/update_company_companies__company_id__patch.md) ### Get all companies - [GET /companies](https://gridsquid.redocly.app/openapi/companies/get_all_companies_companies_get.md) ### Create new company - [POST /companies](https://gridsquid.redocly.app/openapi/companies/create_new_company_companies_post.md) ## Users individual associated with a company in Grid Squid. Each user must authenticate with their individual CRM credentials (e.g., username and password or access tokens) to access CRM data, objects, and activities. Users share access to mappings and bulk imports created within their company. ### Get all users - [GET /companies/{company_id}/users](https://gridsquid.redocly.app/openapi/users/get_all_users_companies__company_id__users_get.md) ### Create new user - [POST /companies/{company_id}/users](https://gridsquid.redocly.app/openapi/users/create_new_user_companies__company_id__users_post.md) ### Get user - [GET /companies/{company_id}/users/{user_id}](https://gridsquid.redocly.app/openapi/users/get_user_companies__company_id__users__user_id__get.md) ### Delete user - [DELETE /companies/{company_id}/users/{user_id}](https://gridsquid.redocly.app/openapi/users/delete_user_companies__company_id__users__user_id__delete.md) ### Create batch users - [POST /companies/{company_id}/users/batch](https://gridsquid.redocly.app/openapi/users/create_batch_users_companies__company_id__users_batch_post.md) ## Mappings customizable workflow designed to extract, transform, and prepare CRM data for integration with other applications. Users can specify the CRM object (e.g., leads, opportunities) and define the fields required by the target system. Advanced transformations, such as validations, filtering and data quality checks, can be implemented using custom JavaScript. Mappings are created within a company and shared among all its users. The data retrieved through a mapping respects the access level and permissions of the individual user in the CRM. ### Get all mappings - [GET /companies/{company_id}/mappings](https://gridsquid.redocly.app/openapi/mappings/get_all_mappings_companies__company_id__mappings_get.md) ### Create mapping - [POST /companies/{company_id}/mappings](https://gridsquid.redocly.app/openapi/mappings/create_mapping_companies__company_id__mappings_post.md) ### Update mapping - [PATCH /companies/{company_id}/mappings/{mapping_id}](https://gridsquid.redocly.app/openapi/mappings/update_mapping_companies__company_id__mappings__mapping_id__patch.md) ### Delete mapping - [DELETE /companies/{company_id}/mappings/{badger_object_name}](https://gridsquid.redocly.app/openapi/mappings/delete_mapping_companies__company_id__mappings__badger_object_name__delete.md) ## Events Notifications of changes occurring on the CRM side. ### Create event configuration - [POST /event-configurations](https://gridsquid.redocly.app/openapi/events/create_event_configuration_event_configurations__post.md) ### Get all - [GET /event-configurations](https://gridsquid.redocly.app/openapi/events/get_all_event_configurations__get.md) ### Update - [PATCH /event-configurations/{event_configuration_id}](https://gridsquid.redocly.app/openapi/events/update_event_configurations__event_configuration_id__patch.md) ### Delete - [DELETE /event-configurations/{event_configuration_id}](https://gridsquid.redocly.app/openapi/events/delete_event_configurations__event_configuration_id__delete.md) ## Records - Transformed Manage CRM records applying your own mappings ### Create record - [POST /users/{user_id}/records/unified/{badger_object_name}](https://gridsquid.redocly.app/openapi/records-transformed/create_record_users__user_id__records_unified__badger_object_name__post.md) ### Get records - [GET /users/{user_id}/records/unified/{badger_object_name}](https://gridsquid.redocly.app/openapi/records-transformed/get_records_users__user_id__records_unified__badger_object_name__get.md) ### Get record - [GET /users/{user_id}/records/unified/{badger_object_name}/{record_id}](https://gridsquid.redocly.app/openapi/records-transformed/get_record_users__user_id__records_unified__badger_object_name___record_id__get.md) ### Update record - [PATCH /users/{user_id}/records/unified/{badger_object_name}/{record_id}](https://gridsquid.redocly.app/openapi/records-transformed/update_record_users__user_id__records_unified__badger_object_name___record_id__patch.md) ### Delete record - [DELETE /users/{user_id}/records/unified/{badger_object_name}/{record_id}](https://gridsquid.redocly.app/openapi/records-transformed/delete_record_users__user_id__records_unified__badger_object_name___record_id__delete.md) ## Records - Raw Manage CRM records without applying your own mappings ### Create raw record - [POST /users/{user_id}/records/raw/{crm_object_name}](https://gridsquid.redocly.app/openapi/records-raw/create_raw_record_users__user_id__records_raw__crm_object_name__post.md) ### Get raw records - [GET /users/{user_id}/records/raw/{crm_object_name}](https://gridsquid.redocly.app/openapi/records-raw/get_raw_records_users__user_id__records_raw__crm_object_name__get.md) ### Get raw record - [GET /users/{user_id}/records/raw/{crm_object_name}/{record_id}](https://gridsquid.redocly.app/openapi/records-raw/get_raw_record_users__user_id__records_raw__crm_object_name___record_id__get.md) ### Update raw record - [PATCH /users/{user_id}/records/raw/{crm_object_name}/{record_id}](https://gridsquid.redocly.app/openapi/records-raw/update_raw_record_users__user_id__records_raw__crm_object_name___record_id__patch.md) ### Delete raw record - [DELETE /users/{user_id}/records/raw/{crm_object_name}/{record_id}](https://gridsquid.redocly.app/openapi/records-raw/delete_raw_record_users__user_id__records_raw__crm_object_name___record_id__delete.md) ## Bulks retrieval of large volumes of data from a CRM for a specific object. ### Create bulk job - [POST /users/{user_id}/bulks](https://gridsquid.redocly.app/openapi/bulks/create_bulk_job_users__user_id__bulks_post.md) ### Get job status - [GET /users/{user_id}/bulks/{bulk_job_id}/status](https://gridsquid.redocly.app/openapi/bulks/get_job_status_users__user_id__bulks__bulk_job_id__status_get.md) ### Get job result - [GET /users/{user_id}/bulks/{bulk_job_id}/result](https://gridsquid.redocly.app/openapi/bulks/get_job_result_users__user_id__bulks__bulk_job_id__result_get.md) ### Get bulk jobs - [GET /companies/{company_id}/bulks](https://gridsquid.redocly.app/openapi/bulks/get_bulk_jobs_companies__company_id__bulks_get.md) ### Get bulk status jobs - [GET /companies/{company_id}/status](https://gridsquid.redocly.app/openapi/bulks/get_bulk_status_jobs_companies__company_id__status_get.md) ## Authentication Connect your users to access the CRM on their behalf. ### Login - [GET /users/{user_id}/login](https://gridsquid.redocly.app/openapi/authentication/login_users__user_id__login__get.md) ### Create new auth credentials - [POST /users/{user_id}/auth-credentials](https://gridsquid.redocly.app/openapi/authentication/create_new_auth_credentials_users__user_id__auth_credentials__post.md) ### Delete auth credentials - [DELETE /users/{user_id}/auth-credentials](https://gridsquid.redocly.app/openapi/authentication/delete_auth_credentials_users__user_id__auth_credentials__delete.md) ### Login redirect - [GET /crm/callback/oauth](https://gridsquid.redocly.app/openapi/authentication/login_redirect_crm_callback_oauth__get.md) ### Check connection health - [GET /users/{user_id}/connection-health](https://gridsquid.redocly.app/openapi/authentication/check_connection_health_users__user_id__connection_health__get.md) ### Get company connection health - [GET /companies/{company_id}/connection-health](https://gridsquid.redocly.app/openapi/authentication/get_company_connection_health_companies__company_id__connection_health__get.md) ## Mass Update Update several records with just one API call using your mappings. ### Mass update records - [PATCH /users/{user_id}/mass-update/{badger_object_name}](https://gridsquid.redocly.app/openapi/mass-update/mass_update_records_users__user_id__mass_update__badger_object_name__patch.md) ### Get mass update status - [GET /users/{user_id}/mass-update/jobs/{mass_update_job_id}/status](https://gridsquid.redocly.app/openapi/mass-update/get_mass_update_status_users__user_id__mass_update_jobs__mass_update_job_id__status_get.md) ## Metadata Retrieve CRM metadata such as Objects, fields and users. ### Get objects - [GET /users/{user_id}/metadata/objects](https://gridsquid.redocly.app/openapi/metadata/get_objects_users__user_id__metadata_objects_get.md) ### Get object fields - [GET /users/{user_id}/metadata/objects/{crm_object_name}/fields](https://gridsquid.redocly.app/openapi/metadata/get_object_fields_users__user_id__metadata_objects__crm_object_name__fields_get.md) ### Get crm users - [GET /users/{user_id}/metadata/crm-users](https://gridsquid.redocly.app/openapi/metadata/get_crm_users_users__user_id__metadata_crm_users_get.md) ## Netsuite Integration Credentials Authenticate your Netsuite users. ### Create netsuite integration credentials - [POST /netsuite/{company_id}/integration-credentials](https://gridsquid.redocly.app/openapi/netsuite-integration-credentials/create_netsuite_integration_credentials_netsuite__company_id__integration_credentials__post.md) ## Insightly Integration Credentials Authenticate your Insightly users. ### Insightly login page - [GET /insightly/login](https://gridsquid.redocly.app/openapi/insightly-integration-credentials/insightly_login_page_insightly_login_get.md) ### Create integration credentials - [POST /insightly/integration-credentials](https://gridsquid.redocly.app/openapi/insightly-integration-credentials/create_integration_credentials_insightly_integration_credentials__post.md) ## Netsuite Saved Search Set up your Netsuite saved searches so you can retrieve records. ### Create netsuite saved search - [POST /netsuite/mappings/{mapping_id}/saved-search](https://gridsquid.redocly.app/openapi/netsuite-saved-search/create_netsuite_saved_search_netsuite_mappings__mapping_id__saved_search__post.md) ## Netsuite Script Deployment Set up your Netsuite Scripts to be run on mappings. ### Create netsuite script deployment - [POST /netsuite/{company_id}/script-deployment](https://gridsquid.redocly.app/openapi/netsuite-script-deployment/create_netsuite_script_deployment_netsuite__company_id__script_deployment__post.md)