Users

List Users

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · int32 · min: 1Optional

perPageinteger · int32 · min: 1 · max: 100Optional

querystringOptional

sortstringOptional

sortDirstring · enumOptionalPossible values:

Responses

200

List of users

application/json

totalRowsnumberOptional

pagenumberOptional

perPagenumberOptional

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/users

HTTPcURLJavaScriptPython

GET /v2/users HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalRows": 1,
  "page": 1,
  "perPage": 1,
  "rows": [
    {
      "userId": "auth0|617545b5181e16506a050fa5",
      "companyId": "company_abc123",
      "email": "[e-mail]",
      "firstName": "Bob",
      "lastName": "Johnson",
      "phoneNumber": "15551234567",
      "active": true,
      "timestamp": {
        "created": 1672531200,
        "updated": 1672617600,
        "lastLogin": 1672704000
      }
    }
  ]
}

Retrieve User

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the User

Responses

200

Details about the user

application/json

userIdstringRequired

The unique user ID from Auth0

companyIdstringRequired

The company ID this user belongs to

emailstringRequired

The email address of the user

firstNamestringOptional

The first name of the user

lastNamestringOptional

The last name of the user

phoneNumberstringOptional

The phone number of the user

activebooleanRequired

Whether the user account is active

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/users/{id}

HTTPcURLJavaScriptPython

GET /v2/users/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "userId": "auth0|617545b5181e16506a050fa5",
  "companyId": "company_abc123",
  "email": "[e-mail]",
  "firstName": "Bob",
  "lastName": "Johnson",
  "phoneNumber": "15551234567",
  "active": true,
  "timestamp": {
    "created": 1672531200,
    "updated": 1672617600,
    "lastLogin": 1672704000
  }
}