API Reference
  1. Accounts
  2. User

List all users.

get
https://api.podium.com/v4/users

List of all the users that belong to any of the locations that the caller has access to.

If the cursor parameter is used then all other parameters will be ignored. This is to avoid confusion if passing both a cursor and other parameters which would change what data is being returned.

Required scope: read_users.

Query Params
string

String you would like to search for in the searchFields parameter.

createdAt
object

Filter on the createdAt date.

searchFields
array of strings
Defaults to fullName

A list of the fields where you want to search for the search parameters. e.g. ?searchFields[]=name&searchFields[]=displayname

searchFields
Allowed:
integer
0 to 100
Defaults to 10

Max number of items to return per request. Defaults to 10.

string

Retrieves the page of items that comes after the cursor.

boolean
Defaults to true

Include users with ai_agent role. Defaults to true if not specified.

Responses

Callback

Updated about 2 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?