SalesOS.

Import/ Export

Data import and export

Import Export Controller_preview Import

POST
/v1/import-export/preview

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

entityTypeRequiredstring
curl -X POST "https://api.salesos.org/v1/import-export/preview?entityType=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Import Export Controller_import Records

POST
/v1/import-export/import

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired
curl -X POST "https://api.salesos.org/v1/import-export/import" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Import Export Controller_export Records

POST
/v1/import-export/export

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Request Body

application/jsonRequired
curl -X POST "https://api.salesos.org/v1/import-export/export" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Import Export Controller_download Export

GET
/v1/import-export/download/{fileName}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

fileNameRequiredstring
curl -X GET "https://api.salesos.org/v1/import-export/download/<string>" \
  -H "Authorization: Bearer <token>"

Import Export Controller_get Export Fields

GET
/v1/import-export/fields/{entityType}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

entityTypeRequiredstring
curl -X GET "https://api.salesos.org/v1/import-export/fields/<string>" \
  -H "Authorization: Bearer <token>"

Import Export Controller_get Import Template

GET
/v1/import-export/template/{entityType}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

entityTypeRequiredstring

Query Parameters

formatRequiredstring
curl -X GET "https://api.salesos.org/v1/import-export/template/<string>?format=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Import Export Controller_get C R M Template

GET
/v1/import-export/crm-template/{crmType}/{entityType}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

crmTypeRequiredstring
entityTypeRequiredstring
curl -X GET "https://api.salesos.org/v1/import-export/crm-template/<string>/<string>" \
  -H "Authorization: Bearer <token>"

Import Export Controller_suggest Mappings

POST
/v1/import-export/suggest-mappings

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://api.salesos.org/v1/import-export/suggest-mappings" \
  -H "Authorization: Bearer <token>"

Import Export Controller_detect C R M

POST
/v1/import-export/detect-crm

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://api.salesos.org/v1/import-export/detect-crm" \
  -H "Authorization: Bearer <token>"

Import Export Controller_get Migration History

GET
/v1/import-export/migrations

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

sourceCRMRequiredstring
entityTypeRequiredstring
statusRequiredstring
limitRequiredstring
offsetRequiredstring
curl -X GET "https://api.salesos.org/v1/import-export/migrations?sourceCRM=%3Cstring%3E&entityType=%3Cstring%3E&status=%3Cstring%3E&limit=%3Cstring%3E&offset=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Import Export Controller_create Migration

POST
/v1/import-export/migrations

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://api.salesos.org/v1/import-export/migrations" \
  -H "Authorization: Bearer <token>"

Import Export Controller_get Migration Stats

GET
/v1/import-export/migrations/stats

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/import-export/migrations/stats" \
  -H "Authorization: Bearer <token>"

Import Export Controller_get Migration Status

GET
/v1/import-export/migrations/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.salesos.org/v1/import-export/migrations/<string>" \
  -H "Authorization: Bearer <token>"

Import Export Controller_delete Migration

DELETE
/v1/import-export/migrations/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X DELETE "https://api.salesos.org/v1/import-export/migrations/<string>" \
  -H "Authorization: Bearer <token>"

Import Export Controller_cancel Migration

POST
/v1/import-export/migrations/{id}/cancel

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X POST "https://api.salesos.org/v1/import-export/migrations/<string>/cancel" \
  -H "Authorization: Bearer <token>"

Import Export Controller_download C R M Template

GET
/v1/import-export/crm-template-download/{crmType}/{entityType}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

crmTypeRequiredstring
entityTypeRequiredstring
curl -X GET "https://api.salesos.org/v1/import-export/crm-template-download/<string>/<string>" \
  -H "Authorization: Bearer <token>"