Sign in

v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-013593344.3 KB
Users

List Users

Browse through all the users in your workspace. Filter by organization to see who belongs to specific teams or companies. Results are paginated for easy navigation through large user bases.

get/users

Query parameters

limitnumber

Maximum number of results to return.

Maximum number of results to return.

offsetnumber

Offset for pagination.

Offset for pagination.

pagenumber

Page number (used to derive offset = (page-1)*limit).

Page number (used to derive offset = (page-1)*limit).

organizationIdstring uuid

Filter users by organization ID.

Filter users by organization ID.

Response

Users retrieved successfully

idstring required

The Greenflash participant ID.

externalIdstring required

Your external user ID (matches the externalUserId from the request).

organizationIdstring uuid nullable required

The internal organization ID that the user belongs to.

externalOrganizationIdstring nullable required

Your external identifier for the user's organization.

namestring

The participant's full name.

emailstring

The participant's email address.

phonestring

The participant's phone number.

anonymizedboolean required

Whether the participant's personal information is anonymized.

propertiesobject required

Additional data about the participant.

createdAtstring date-time

When the participant was first created.

updatedAtstring date-time

When the participant was last updated.