Siteglide.comAdminRoadmap

CRM Users

Retrieve an overview list of all CRM users from your website

get
Authorizations
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

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

No content

Retrieve all data about an individual CRM user

get
Authorizations
Path parameters
idstring · idRequired

The ID or Email Address of the user

Example: 1234 or [email protected]
Responses
200

OK

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

No content

Update a CRM user

put
Authorizations
Path parameters
idstring · idRequired

The ID of the user

Example: 1234
Body
namestringRequired
emailstringRequired
passwordstringOptional
secure_zonesstringOptional
cfs_field_1_1stringOptional
Responses
200

OK

No content
put
PUT /api/site/v2/users/{id} HTTP/1.1
Host: {{your site}}
x-api-key: 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
Body
namestringRequired
emailstringRequired
passwordstringOptional
secure_zonesstringOptional
cfs_field_1_1stringOptional
Responses
200

OK

No content
post
POST /api/site/v2/users/create HTTP/1.1
Host: {{your site}}
x-api-key: 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
PreviousWebAppsNexteCommerce

Last updated

Was this helpful?