Authentication

Grid Squid (1.0.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://gridsquid.redocly.app/_mock/openapi/
https://{yourDomain}.gridsquid.io/

Companies

group of users pointing to a specific CRM instance

Operations

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

Login

Request

Path
user_idstring(uuid)(User Id)required
curl -i -X GET \
  'https://gridsquid.redocly.app/_mock/openapi/users/{user_id}/login' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Create new auth credentials

Request

Path
user_idstring(uuid)(User Id)required
Bodyapplication/jsonrequired
auth_typestring(AuthTypes)required
Example: "OAUTH_2"
Value "OAUTH_2"
token_informationobject(TokenInformation)required
token_information.​access_tokenstring(Access Token)required
Example: "SOMETOKEN"
token_information.​refresh_tokenstring(Refresh Token)required
Example: "SOMETOKEN"
curl -i -X POST \
  'https://gridsquid.redocly.app/_mock/openapi/users/{user_id}/auth-credentials' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auth_type": "OAUTH_2",
    "token_information": {
      "access_token": "SOMETOKEN",
      "refresh_token": "SOMETOKEN"
    }
  }'

Responses

Successful Response

Bodyapplication/json
user_idstring(uuid)(User Id)required
Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
auth_typestring(AuthTypes)required
Value "OAUTH_2"
token_informationTokenInformation (object) or nullrequired
Any of:
token_information.​access_tokenstring(Access Token)required
Example: "SOMETOKEN"
token_information.​refresh_tokenstring(Refresh Token)required
Example: "SOMETOKEN"
Response
application/json
{
  "user_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "auth_type": "OAUTH_2",
  "token_information": {
    "access_token": "SOMETOKEN",
    "refresh_token": "SOMETOKEN"
  }
}

Delete auth credentials

Request

Path
user_idstring(uuid)(User Id)required
curl -i -X DELETE \
  'https://gridsquid.redocly.app/_mock/openapi/users/{user_id}/auth-credentials' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Login redirect

Request

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

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Check connection health

Request

Path
user_idstring(uuid)(User Id)required
curl -i -X GET \
  'https://gridsquid.redocly.app/_mock/openapi/users/{user_id}/connection-health' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
connection_healthboolean(Connection Health)required
Example: true
Response
application/json
{
  "connection_health": true
}

Get company connection health

Request

Path
company_idstring(uuid)(Company Id)required
curl -i -X GET \
  'https://gridsquid.redocly.app/_mock/openapi/companies/{company_id}/connection-health' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
itemsArray of objects(Items)required
items[].​user_idstring(uuid)(User Id)required
Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
items[].​connection_healthboolean(Connection Health)required
Example: true
Response
application/json
{
  "items": [
    { … }
  ]
}

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