cURL
curl --request GET \
--url 'https://api.momentum.io/v1/users?pageSize=50&licenseAdded=true' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch(
"https://api.momentum.io/v1/users?pageSize=50&licenseAdded=true",
{
headers: { "X-API-Key": "YOUR_API_KEY" },
}
);
const data = await response.json();
import requests
response = requests.get(
"https://api.momentum.io/v1/users",
headers={"X-API-Key": "YOUR_API_KEY"},
params={
"pageSize": 50,
"licenseAdded": "true",
},
)
data = response.json()
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.momentum.io/v1/users"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"users": [
{
"email": "jsmith@example.com",
"name": "<string>",
"role": "viewer",
"type": "<string>",
"licenseAdded": true,
"salesforceAuthStatus": "AUTHENTICATED",
"gcalAuthStatus": "AUTHENTICATED",
"slackUserId": "<string>",
"title": "<string>",
"salesforceDepartment": "<string>",
"salesforceUserRole": "<string>",
"licenseAssignedAt": "2023-11-07T05:31:56Z"
}
],
"pageCount": 123
}{
"error": "<string>"
}{
"error": "Internal server error"
}Users
Retrieve a list of users
Returns a paginated list of users in your organization with their profile, license, and integration status.
GET
/
v1
/
users
cURL
curl --request GET \
--url 'https://api.momentum.io/v1/users?pageSize=50&licenseAdded=true' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch(
"https://api.momentum.io/v1/users?pageSize=50&licenseAdded=true",
{
headers: { "X-API-Key": "YOUR_API_KEY" },
}
);
const data = await response.json();
import requests
response = requests.get(
"https://api.momentum.io/v1/users",
headers={"X-API-Key": "YOUR_API_KEY"},
params={
"pageSize": 50,
"licenseAdded": "true",
},
)
data = response.json()
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.momentum.io/v1/users"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"users": [
{
"email": "jsmith@example.com",
"name": "<string>",
"role": "viewer",
"type": "<string>",
"licenseAdded": true,
"salesforceAuthStatus": "AUTHENTICATED",
"gcalAuthStatus": "AUTHENTICATED",
"slackUserId": "<string>",
"title": "<string>",
"salesforceDepartment": "<string>",
"salesforceUserRole": "<string>",
"licenseAssignedAt": "2023-11-07T05:31:56Z"
}
],
"pageCount": 123
}{
"error": "<string>"
}{
"error": "Internal server error"
}Authorizations
API key for authenticating requests
Query Parameters
The page number to retrieve (1-based indexing). Defaults to 1 if not specified.
Required range:
x >= 1The maximum number of users to return per page. Must be between 1 and 50. Defaults to 10 if not specified.
Required range:
1 <= x <= 50Filter users by license status. Use 'true' for licensed users, 'false' for unlicensed users.
Filter users by role.
Available options:
VIEWER, EDITOR, ORGANIZATION_ADMIN, USER_ADMIN, USER 
