CRM Users

Retrieve an overview list of all CRM users from your website

get

Authorizations

apiKey & siteID

x-api-keystringRequired

x-site-idstringRequired

Query parameters

per_pageintegerOptional

Number of items to retireve, maximum of 500

Example: 20

sort_typestringOptional

Property by which to sort the results

Example: created_at

sort_orderstringOptional

Order of results (asc or desc)

Example: desc

pageintOptional

Page to retrieve number, to be used with per_page

Example: 1

Responses

200

OK

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

404

Not Found - The CRM does not contain any users

422

Unprocessable Entity - Required data missing or data invalid

get

/users

HTTPcURLJavaScriptPython

GET /api/site/v2/users HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: YOUR_API_KEY
Accept: */*

No content

Retrieve all data about an individual CRM user

get

Authorizations

apiKey & siteID

x-api-keystringRequired

x-site-idstringRequired

Path parameters

idstring · idRequired

The ID or Email Address of the user

Example: 1234 or [email protected]

Responses

200

OK

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

404

Not Found - CRM user does not exist

422

Unprocessable Entity - Required data missing or data invalid

get

/users/{id}

HTTPcURLJavaScriptPython

GET /api/site/v2/users/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: YOUR_API_KEY
Accept: */*

No content

Update a CRM user

put

Authorizations

apiKey & siteID

x-api-keystringRequired

x-site-idstringRequired

Path parameters

idstring · idRequired

The ID of the user

Example: 1234

Body

application/json

namestringRequired

emailstringRequired

passwordstringOptional

secure_zonesstringOptional

cfs_field_1_1stringOptional

Responses

200

OK

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

404

Not Found - CRM user does not exist

422

Unprocessable Entity - Required data missing or data invalid

put

/users/{id}

HTTPcURLJavaScriptPython

PUT /api/site/v2/users/{id} HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "name": "text",
  "email": "text",
  "password": "text",
  "secure_zones": "text",
  "cfs_field_1_1": "text"
}

No content

Create a CRM user

post

Authorizations

apiKey & siteID

x-api-keystringRequired

x-site-idstringRequired

Body

application/json

namestringRequired

emailstringRequired

passwordstringOptional

secure_zonesstringOptional

cfs_field_1_1stringOptional

Responses

200

OK

401

Unauthorized - Credentials Incorrect

403

Forbidden - You cannot access this site

404

Not Found - CRM user does not exist

422

Unprocessable Entity - Required data missing or data invalid

post

/users/create

HTTPcURLJavaScriptPython

POST /api/site/v2/users/create HTTP/1.1
Host: {{your site}}
x-api-key: YOUR_API_KEY
x-site-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "name": "text",
  "email": "text",
  "password": "text",
  "secure_zones": "text",
  "cfs_field_1_1": "text"
}

No content