🔗CRM Users

Retrieve an overview list of all CRM users from your website

get

/api/public/site/users/crm

Authorizations

SessionKeySiteID

Query parameters

per_pageinteger

Number of items to retireve, maximum of 500

Example: 20

sort_typestring

Property by which to sort the results

Example: created_at

sort_orderstring

Order of results (asc or desc)

Example: desc

pageint

Page to retrieve number, to be used with per_page

Example: 1

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/site/users/crm' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

422

200

No body

OK

Retrieve all data about an individual CRM user

get

/api/public/site/users/crm/{id}

Authorizations

SessionKeySiteID

Path parameters

idstring · idrequired

The ID or Email Address of the user

Example: 1234 or [e-mail]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/public/site/users/crm/{id}' \
  --header 'authorization: YOUR_API_KEY'

200

401

403

404

422

200

No body

OK

Update a CRM user

put

/api/public/site/users/crm/{id}

Authorizations

SessionKeySiteID

Path parameters

idstring · idrequired

The ID of the user

Example: 1234

Body

namestringrequired

emailstringrequired

passwordstring

secure_zonesstring

cfs_field_1_1string

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/public/site/users/crm/{id}' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "email": "text",
    "password": "text",
    "secure_zones": "text",
    "cfs_field_1_1": "text"
  }'

200

401

403

404

422

200

No body

OK

Create a CRM user

post

/api/public/site/users/crm/create

Authorizations

SessionKeySiteID

Body

namestringrequired

emailstringrequired

passwordstring

secure_zonesstring

cfs_field_1_1string

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/public/site/users/crm/create' \
  --header 'authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "email": "text",
    "password": "text",
    "secure_zones": "text",
    "cfs_field_1_1": "text"
  }'

200

401

403

404

422

200

No body

OK