Retrieves a list of users from an account

GET /settings/v3/users/

Copy endpoint

https://api.hubapi.com

Parameters

query Query Parameters

Name	Type
`after` Results will display maximum 100 users per page. Additional results will be on the next page.	string
`limit` The number of users to retrieve	number

Responses

200 application/json

successful operation

interface CollectionResponsePublicUserForwardPaging {
paging?:

ForwardPaging19

interface ForwardPaging19 {
next?: NextPage;
}

;
results:

PublicUser

A user

interface PublicUser {
email: string;
firstName?: string;
id: string;
lastName?: string;
primaryTeamId?: string;
roleId?: string;
roleIds?: string[];
secondaryTeamIds?: string[];
sendWelcomeEmail?: boolean;
superAdmin?: boolean;
}

[];
}

default */*

An error occurred.

interface Error {
category: string;
context?: { };
correlationId: string;
errors?:

ErrorDetail

interface ErrorDetail {
code?: string;
context?: { };
in?: string;
message: string;
subCategory?: string;
}

[];
links?: { };
message: string;
subCategory?: string;
}