Skip to main content
GET
/
api
/
v1
/
company
/
{companyId}
/
users
GET /api/v1/company/{companyId}/users
curl --request GET \
  --url https://api.scoot.app/api/v1/company/{companyId}/users \
  --header 'X-API-Key: <api-key>'
[
  {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "firstName": "<string>",
    "middleName": "<string>",
    "lastName": "<string>",
    "emailAddress": "<string>",
    "emailVerified": true,
    "preload": true,
    "mobilePhone": "<string>",
    "mobilePhoneVerified": true,
    "mobilePhoneVerifiedWeb": true,
    "profileId": "<string>",
    "profileImageURI": "<string>",
    "profileImageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "profileImageBackground": "<string>",
    "timeZone": "<string>",
    "registeredDateTime": "2023-11-07T05:31:56Z",
    "active": true,
    "actedAs": true
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.scoot.app/llms.txt

Use this file to discover all available pages before exploring further.

Retrieves all users associated with a specific company.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
companyId
string<uuid>
required

Query Parameters

​
page
integer
default:0

Page number to get, used with pageSize

​
size
integer
default:20

Number of items to get in one request, used with page

​
sort
string

Property to sort by. Append ',' and directions 'asc/desc' to change direction

Response

200 - application/json

OK

​
userId
string<uuid>
​
name
string
​
firstName
string
​
middleName
string
​
lastName
string
​
emailAddress
string
​
emailVerified
boolean
​
preload
boolean
​
mobilePhone
string
​
mobilePhoneVerified
boolean
​
mobilePhoneVerifiedWeb
boolean
​
profileId
string
​
profileImageURI
string
​
profileImageId
string<uuid>
​
profileImageBackground
string
​
timeZone
string
​
registeredDateTime
string<date-time>
​
active
boolean
​
actedAs
boolean