Mappings

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

Get all mappings

Request

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

Responses

Successful Response

Bodyapplication/json
itemsArray of objects(Items)required
items[].​company_idstring(uuid)(Company Id)required
Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
items[].​crm_object_namestring(Crm Object Name)required
Example: "customers"
items[].​badger_object_namestring(Badger Object Name)required
Example: "Account"
items[].​fieldsArray of objects(Fields)required
items[].​fields[].​crm_fieldobject(Field)required
items[].​fields[].​crm_field.​keystring(Key)required
Example: "field"
items[].​fields[].​badger_fieldobject(Field)required
items[].​fields[].​badger_field.​keystring(Key)required
Example: "field"
items[].​fields[].​typestring(FieldType)required
Enum"string""number""boolean"
items[].​custom_jsstring(Custom Js)
Default "done(transformedObject)"
Example: ""
items[].​idstring(uuid)(Id)required
Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
Response
application/json
{
  "items": [
    { … }
  ]
}

Create mapping

Request

Path
company_idstring(uuid)(Company Id)required
Bodyapplication/jsonrequired
badger_object_namestring(Badger Object Name)required
Example: "customer"
crm_object_namestring(Crm Object Name)required
Example: "Account"
fieldsArray of objects(Fields)required
fields[].​crm_fieldobject(Field)required
fields[].​crm_field.​keystring(Key)required
Example: "field"
fields[].​badger_fieldobject(Field)required
fields[].​badger_field.​keystring(Key)required
Example: "field"
fields[].​typestring(FieldType)required
Enum"string""number""boolean"
custom_jsstring(Custom Js)
Default "done(transformedObject)"
Example: ""
curl -i -X POST \
  'https://gridsquid.redocly.app/_mock/openapi/companies/{company_id}/mappings' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "badger_object_name": "customer",
    "crm_object_name": "Account",
    "fields": [
      {
        "crm_field": {
          "key": "field"
        },
        "badger_field": {
          "key": "field"
        },
        "type": "string"
      }
    ],
    "custom_js": ""
  }'

Responses

Successful Response

Bodyapplication/json
company_idstring(uuid)(Company Id)required
Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
crm_object_namestring(Crm Object Name)required
Example: "customers"
badger_object_namestring(Badger Object Name)required
Example: "Account"
fieldsArray of objects(Fields)required
fields[].​crm_fieldobject(Field)required
fields[].​crm_field.​keystring(Key)required
Example: "field"
fields[].​badger_fieldobject(Field)required
fields[].​badger_field.​keystring(Key)required
Example: "field"
fields[].​typestring(FieldType)required
Enum"string""number""boolean"
custom_jsstring(Custom Js)
Default "done(transformedObject)"
Example: ""
idstring(uuid)(Id)required
Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
Response
application/json
{
  "company_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "crm_object_name": "customers",
  "badger_object_name": "Account",
  "fields": [
    { … }
  ],
  "custom_js": "",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Update mapping

Request

Path
company_idstring(uuid)(Company Id)required
mapping_idstring(uuid)(Mapping Id)required
Bodyapplication/jsonrequired
badger_object_namestring(Badger Object Name)required
Example: "customer"
crm_object_namestring(Crm Object Name)required
Example: "Account"
fieldsArray of objects(Fields)required
fields[].​crm_fieldobject(Field)required
fields[].​crm_field.​keystring(Key)required
Example: "field"
fields[].​badger_fieldobject(Field)required
fields[].​badger_field.​keystring(Key)required
Example: "field"
fields[].​typestring(FieldType)required
Enum"string""number""boolean"
custom_jsstring(Custom Js)
Default "done(transformedObject)"
Example: ""
curl -i -X PATCH \
  'https://gridsquid.redocly.app/_mock/openapi/companies/{company_id}/mappings/{mapping_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "badger_object_name": "customer",
    "crm_object_name": "Account",
    "fields": [
      {
        "crm_field": {
          "key": "field"
        },
        "badger_field": {
          "key": "field"
        },
        "type": "string"
      }
    ],
    "custom_js": ""
  }'

Responses

Successful Response

Bodyapplication/json
company_idstring(uuid)(Company Id)required
Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
crm_object_namestring(Crm Object Name)required
Example: "customers"
badger_object_namestring(Badger Object Name)required
Example: "Account"
fieldsArray of objects(Fields)required
fields[].​crm_fieldobject(Field)required
fields[].​crm_field.​keystring(Key)required
Example: "field"
fields[].​badger_fieldobject(Field)required
fields[].​badger_field.​keystring(Key)required
Example: "field"
fields[].​typestring(FieldType)required
Enum"string""number""boolean"
custom_jsstring(Custom Js)
Default "done(transformedObject)"
Example: ""
idstring(uuid)(Id)required
Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
Response
application/json
{
  "company_id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "crm_object_name": "customers",
  "badger_object_name": "Account",
  "fields": [
    { … }
  ],
  "custom_js": "",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Delete mapping

Request

Path
company_idstring(uuid)(Company Id)required
badger_object_namestring(Badger Object Name)required
curl -i -X DELETE \
  'https://gridsquid.redocly.app/_mock/openapi/companies/{company_id}/mappings/{badger_object_name}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

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