Hq

WIP: A summary needs to be written for Hq

GET/v3/user

List Users

Find all users

Query String parameters

  • Name
    collate
    Type
    boolean
    Description
    if set to true, use natural sort collation when used with orderBy
  • Name
    ids
    Type
    array
    Description
  • Name
    limit
    Type
    number
    Description
    the limit on the number of records to return
  • Name
    orderby
    Type
    string
    Description
    the order instructions for the result
  • Name
    params
    Type
    string
    Description
    additional request specific params
  • Name
    skip
    Type
    number
    Description
    the number of records to skip for a paginated result
  • Name
    where
    Type
    one of: any, any
    Description
    an object to use for filtering the results

Produces

The response content type: application/json

200 Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    array Required
    Description
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if success = false
  • Name
    meta
    Type
    object
    Description
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Properties for meta object

  • Name
    hasMore
    Type
    boolean
    Description
    if there are more records available
  • Name
    sums
    Type
    object
    Description
  • Name
    total
    Type
    number
    Description
    the total number of records

4xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

5xx Response

  • Name
    code
    Type
    string
    Description
    The error code
  • Name
    data
    Type
    object
    Description
    An optional object containing relevant error data
  • Name
    documentation_url
    Type
    string
    Description
    An optional link to the documentation for the error
  • Name
    message
    Type
    string
    Description
    the error message if not successful
  • Name
    success
    Type
    boolean Required
    Description
    if successful, will be true. if not successful, will be false and message will contain a human readable error message

Example Request

GET
/v3/user
curl https://api.shopmonkey.cloud/v3/user \
  -H "Authorization: Bearer ${SM_TOKEN}"

Example Response
application/json

{
  "success": true,
  "data": [
    {
      "id": "id",
      "createdDate": "createdDate",
      "updatedDate": null,
      "companyId": "companyId",
      "active": true,
      "deactivatedByUserId": null,
      "deactivatedDate": null,
      "laborRateId": null,
      "firstName": "firstName",
      "lastName": "lastName",
      "email": "email",
      "phone": null,
      "color": "color",
      "currentLocationId": null,
      "customFields": {},
      "laborRate": {
        "valueCents": 1
      },
      "userRoles": [
        {
          "role": {
            "id": "id",
            "name": "name",
            "derivedFrom": {
              "name": "name"
            }
          }
        }
      ],
      "deactivator": {
        "id": "id",
        "companyId": "companyId",
        "active": true,
        "firstName": "firstName",
        "lastName": "lastName",
        "color": "color"
      },
      "company": {
        "createdDate": "createdDate",
        "name": "name"
      },
      "location": {
        "country": "country",
        "createdDate": "createdDate",
        "name": "name",
        "state": "state",
        "timezone": "timezone",
        "locationConfig": {
          "requireMileageRecordBeforeInvoice": true
        }
      }
    }
  ]
}