Create CRM export

POST/v1/crm/exports

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

filtersCRMRecordFilter[] | null

Show properties

Array of CRMRecordFilter

fieldstringrequired

operatorstring

sourcestring

valueany

formatstring

Allowed:csvjson

limitinteger<int32>

object_kindstringrequired

offsetinteger<int32>

searchstring

sortstring

view_idstring

Responses

200OK

contentstringrequired

created_atstringrequired

formatstringrequired

idstringrequired

object_kindstringrequired

requestanyrequired

resultanyrequired

statusstringrequired

updated_atstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/crm/exports" \
  -H "Content-Type: application/json" \
  -d '{
  "filters": [
    {
      "field": "string",
      "operator": "string",
      "source": "string",
      "value": "string"
    }
  ],
  "format": "csv",
  "limit": 0,
  "object_kind": "string",
  "offset": 0,
  "search": "string",
  "sort": "string",
  "view_id": "string"
}'

const response = await fetch("/v1/crm/exports", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "filters": [
    {
      "field": "string",
      "operator": "string",
      "source": "string",
      "value": "string"
    }
  ],
  "format": "csv",
  "limit": 0,
  "object_kind": "string",
  "offset": 0,
  "search": "string",
  "sort": "string",
  "view_id": "string"
})
});

import requests

response = requests.post(
    "/v1/crm/exports",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "filters": [
    {
      "field": "string",
      "operator": "string",
      "source": "string",
      "value": "string"
    }
  ],
  "format": "csv",
  "limit": 0,
  "object_kind": "string",
  "offset": 0,
  "search": "string",
  "sort": "string",
  "view_id": "string"
},
)

Response

{
  "content": "string",
  "created_at": "string",
  "format": "string",
  "id": "string",
  "object_kind": "string",
  "request": "string",
  "result": "string",
  "status": "string",
  "updated_at": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}