Skip to main content
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'
{
  "users": [
    {
      "email": "jsmith@example.com",
      "name": "<string>",
      "type": "<string>",
      "licenseAdded": true,
      "slackUserId": "<string>",
      "title": "<string>",
      "salesforceDepartment": "<string>",
      "salesforceUserRole": "<string>",
      "licenseAssignedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pageCount": 123
}

Authorizations

​
X-API-Key
string
header
required

API key for authenticating requests

Query Parameters

​
pageNumber
integer<int32>
default:1

The page number to retrieve (1-based indexing). Defaults to 1 if not specified.

Required range: x >= 1
​
pageSize
integer<int32>
default:10

The maximum number of users to return per page. Must be between 1 and 50. Defaults to 10 if not specified.

Required range: 1 <= x <= 50
​
licenseAdded
boolean

Filter users by license status. Use 'true' for licensed users, 'false' for unlicensed users.

​
role
enum<string>

Filter users by role.

Available options:
VIEWER,
EDITOR,
ORGANIZATION_ADMIN,
USER_ADMIN,
USER

Response

A paginated list of users.

​
users
object[]
required
​
pageCount
integer<int32>
required

Total number of pages available for the current query.