Skip to main content
GET
List users

Authorizations

x-meetergo-api-user-id
string
header
required

User ID to act on behalf of. Platform API Keys only (required with an API Key unless the endpoint states otherwise). Requests authenticated with a Personal Access Token are rejected if this header names another user.

Query Parameters

userType
enum<string>

Filter users by type. If not specified, returns all user types.

Available options:
standard,
resource,
api-platform,
partner
limit
number
default:50

Maximum number of users to return

Required range: 1 <= x <= 100
Example:

20

offset
number
default:0

Number of users to skip for pagination

Required range: x >= 0
Example:

0

Response

200 - application/json

Users retrieved successfully

users
object[]
required

Array of users matching the query criteria

total
number
required

Total number of users matching the query criteria (before pagination)

Required range: x >= 0
Example:

25

count
number
required

Number of users returned in this response

Required range: x >= 0
Example:

10

offset
number
required

Number of users skipped (pagination offset)

Required range: x >= 0
Example:

0