Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Users

List Users

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageinteger · int32 · min: 1Optional

Page number to fetch, 1-indexed. Defaults to 1.

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

Number of results per page (1-100). Defaults to the API's standard page size if omitted.

querystringOptional

Lucene-style filter query (e.g. status:active AND createdAt:[2024-01-01 TO *]). Field names match the User object's own fields. This syntax is part of an in-flight migration (see docs/design/lucene-migration-json-filter-spec.md) and may change.

sortstringOptional

Field name to sort by - any top-level field of the User object returned by this endpoint. Defaults to the API's natural order if omitted.

sortDirstring · enumOptional

Sort direction: asc or desc. Only takes effect when sort is set.

Possible values:
Responses
200

List of users

application/json
totalRowsnumberOptional
pagenumberOptional
perPagenumberOptional
get/users
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": "bob.johnson@example.com",
      "firstName": "Bob",
      "lastName": "Johnson",
      "phoneNumber": "15551234567",
      "active": true,
      "timestamp": {
        "created": 1672531200,
        "updated": 1672617600,
        "lastLogin": 1672704000
      }
    }
  ]
}

Retrieve User

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

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

{
  "userId": "auth0|617545b5181e16506a050fa5",
  "companyId": "company_abc123",
  "email": "bob.johnson@example.com",
  "firstName": "Bob",
  "lastName": "Johnson",
  "phoneNumber": "15551234567",
  "active": true,
  "timestamp": {
    "created": 1672531200,
    "updated": 1672617600,
    "lastLogin": 1672704000
  }
}

Last updated

Was this helpful?