Grid Squid (1.0.0)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Mock server

https://gridsquid.redocly.app/_mock/openapi/

https://{yourDomain}.gridsquid.io/

Companies

group of users pointing to a specific CRM instance

Operations

Get company

Request

Path

company_idstring(uuid)(Company Id)required

curl -i -X GET \
  'https://gridsquid.redocly.app/_mock/openapi/companies/{company_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json

crmstring(CRMs)required

Enum"SALESFORCE""HUBSPOT""DYNAMICS""ZOHO""INSIGHTLY""NETSUITE"

Example: "SALESFORCE"

login_urlstring(Login Url)required

Example: "https://domain.my.salesforce.com"

api_urlstring(Api Url)required

Example: "https://domain.my.salesforce.com"

login_redirect_urlstring(Login Redirect Url)required

Example: "https://my-app.com"

namestring(Name)required

Example: "Acme INC."

environmentstring(Environment)required

Enum"PRODUCTION""SANDBOX"

Example: "PRODUCTION"

idstring(uuid)(Id)required

Example: "https://domain.my.salesforce.com"

created_atstring(date-time)(Created At)

Default "2024-10-17T10:40:37.928681"

Example: "2024-10-17T10:40:37.928681"

Response

application/json

{
  "crm": "SALESFORCE",
  "login_url": "https://domain.my.salesforce.com",
  "api_url": "https://domain.my.salesforce.com",
  "login_redirect_url": "https://my-app.com",
  "name": "Acme INC.",
  "environment": "PRODUCTION",
  "id": "https://domain.my.salesforce.com",
  "created_at": "2024-10-17T10:40:37.928681"
}

Delete company

Request

Path

company_idstring(uuid)(Company Id)required

curl -i -X DELETE \
  'https://gridsquid.redocly.app/_mock/openapi/companies/{company_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json

any

Response

application/json

null

Update company

Request

Path

company_idstring(uuid)(Company Id)required

Bodyapplication/jsonrequired

crmstring(CRMs)required

Enum"SALESFORCE""HUBSPOT""DYNAMICS""ZOHO""INSIGHTLY""NETSUITE"

Example: "SALESFORCE"

login_urlstring(Login Url)required

Example: "https://domain.my.salesforce.com"

api_urlstring(Api Url)required

Example: "https://domain.my.salesforce.com"

login_redirect_urlstring(Login Redirect Url)required

Example: "https://mydomain.com"

namestring(Name)required

Example: "My Company"

environmentstring(Environment)required

Enum"PRODUCTION""SANDBOX"

Example: "PRODUCTION"

curl -i -X PATCH \
  'https://gridsquid.redocly.app/_mock/openapi/companies/{company_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "crm": "SALESFORCE",
    "login_url": "https://domain.my.salesforce.com",
    "api_url": "https://domain.my.salesforce.com",
    "login_redirect_url": "https://mydomain.com",
    "name": "My Company",
    "environment": "PRODUCTION"
  }'

Responses

Successful Response

Bodyapplication/json

crmstring(CRMs)required

Enum"SALESFORCE""HUBSPOT""DYNAMICS""ZOHO""INSIGHTLY""NETSUITE"

Example: "SALESFORCE"

login_urlstring(Login Url)required

Example: "https://domain.my.salesforce.com"

api_urlstring(Api Url)required

Example: "https://domain.my.salesforce.com"

login_redirect_urlstring(Login Redirect Url)required

Example: "https://my-app.com"

namestring(Name)required

Example: "Acme INC."

environmentstring(Environment)required

Enum"PRODUCTION""SANDBOX"

Example: "PRODUCTION"

idstring(uuid)(Id)required

Example: "https://domain.my.salesforce.com"

created_atstring(date-time)(Created At)

Default "2024-10-17T10:40:37.928681"

Example: "2024-10-17T10:40:37.928681"

Response

application/json

{
  "crm": "SALESFORCE",
  "login_url": "https://domain.my.salesforce.com",
  "api_url": "https://domain.my.salesforce.com",
  "login_redirect_url": "https://my-app.com",
  "name": "Acme INC.",
  "environment": "PRODUCTION",
  "id": "https://domain.my.salesforce.com",
  "created_at": "2024-10-17T10:40:37.928681"
}

Get all companies

Request

curl -i -X GET \
  https://gridsquid.redocly.app/_mock/openapi/companies \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json

itemsArray of objects(Items)required

items[].crmstring(CRMs)required

Enum"SALESFORCE""HUBSPOT""DYNAMICS""ZOHO""INSIGHTLY""NETSUITE"

Example: "SALESFORCE"

items[].login_urlstring(Login Url)required

Example: "https://domain.my.salesforce.com"

items[].api_urlstring(Api Url)required

Example: "https://domain.my.salesforce.com"

items[].login_redirect_urlstring(Login Redirect Url)required

Example: "https://my-app.com"

items[].namestring(Name)required

Example: "Acme INC."

items[].environmentstring(Environment)required

Enum"PRODUCTION""SANDBOX"

Example: "PRODUCTION"

items[].idstring(uuid)(Id)required

Example: "https://domain.my.salesforce.com"

items[].created_atstring(date-time)(Created At)

Default "2024-10-17T10:40:37.928681"

Example: "2024-10-17T10:40:37.928681"

Response

application/json

{
  "items": [
    { … }
  ]
}

Create new company

Request

Bodyapplication/jsonrequired

crmstring(CRMs)required

Enum"SALESFORCE""HUBSPOT""DYNAMICS""ZOHO""INSIGHTLY""NETSUITE"

Example: "SALESFORCE"

login_urlstring(Login Url)required

Example: "https://domain.my.salesforce.com"

api_urlstring(Api Url)required

Example: "https://domain.my.salesforce.com"

login_redirect_urlstring(Login Redirect Url)required

Example: "https://mydomain.com"

namestring(Name)required

Example: "My Company"

environmentstring(Environment)required

Enum"PRODUCTION""SANDBOX"

Example: "PRODUCTION"

curl -i -X POST \
  https://gridsquid.redocly.app/_mock/openapi/companies \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "crm": "SALESFORCE",
    "login_url": "https://domain.my.salesforce.com",
    "api_url": "https://domain.my.salesforce.com",
    "login_redirect_url": "https://mydomain.com",
    "name": "My Company",
    "environment": "PRODUCTION"
  }'

Responses

Successful Response

Bodyapplication/json

crmstring(CRMs)required

Enum"SALESFORCE""HUBSPOT""DYNAMICS""ZOHO""INSIGHTLY""NETSUITE"

Example: "SALESFORCE"

login_urlstring(Login Url)required

Example: "https://domain.my.salesforce.com"

api_urlstring(Api Url)required

Example: "https://domain.my.salesforce.com"

login_redirect_urlstring(Login Redirect Url)required

Example: "https://my-app.com"

namestring(Name)required

Example: "Acme INC."

environmentstring(Environment)required

Enum"PRODUCTION""SANDBOX"

Example: "PRODUCTION"

idstring(uuid)(Id)required

Example: "https://domain.my.salesforce.com"

created_atstring(date-time)(Created At)

Default "2024-10-17T10:40:37.928681"

Example: "2024-10-17T10:40:37.928681"

Response

application/json

{
  "crm": "SALESFORCE",
  "login_url": "https://domain.my.salesforce.com",
  "api_url": "https://domain.my.salesforce.com",
  "login_redirect_url": "https://my-app.com",
  "name": "Acme INC.",
  "environment": "PRODUCTION",
  "id": "https://domain.my.salesforce.com",
  "created_at": "2024-10-17T10:40:37.928681"
}

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.

Operations

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.

Operations

Events

Notifications of changes occurring on the CRM side.

Operations

Records - Transformed

Manage CRM records applying your own mappings

Operations

Records - Raw

Manage CRM records without applying your own mappings

Operations

Bulks

retrieval of large volumes of data from a CRM for a specific object.

Operations

Authentication

Connect your users to access the CRM on their behalf.

Operations

Mass Update

Update several records with just one API call using your mappings.

Operations

Metadata

Retrieve CRM metadata such as Objects, fields and users.

Operations

Netsuite Integration Credentials

Authenticate your Netsuite users.

Operations

Insightly Integration Credentials

Authenticate your Insightly users.

Operations

Netsuite Saved Search

Set up your Netsuite saved searches so you can retrieve records.

Operations

Netsuite Script Deployment

Set up your Netsuite Scripts to be run on mappings.

Operations

Grid Squid (1.0.0)

Companies

Get company

Request

Responses

Was this helpful?

Delete company

Request

Responses

Was this helpful?

Update company

Request

Responses

Was this helpful?

Get all companies

Request

Responses

Was this helpful?

Create new company

Request

Responses

Was this helpful?

Users

Mappings

Events

Records - Transformed

Records - Raw

Bulks

Authentication

Mass Update

Metadata

Netsuite Integration Credentials

Insightly Integration Credentials

Netsuite Saved Search

Netsuite Script Deployment