Skip to main content
GET
Fetch users

Response fields

Each user in the response contains a fixed set of standard fields plus any custom user attributes configured for your Qobra account. Standard fields (always returned):
  • id — user ID (ObjectId)
  • email — user email
  • name — user name
  • status — one of active, archived, inactive, pending
  • role — user role
  • currency — user currency code
  • calculation_currency — currency used for commission calculations
Custom user attributes (returned when configured): Every attribute defined under Qobra settings > User attributes appears in each user object under its own API key. Amount-type attributes also add a <user-attribute-api-key>_currency field alongside the value.
Fields such as business_unit, team, region, or manager are not standard fields on this endpoint. If they exist in your account, they are custom user attributes and appear under the API key you assigned to them in Qobra settings > User attributes.

Discover your custom user attribute API keys

Custom user attributes are defined per Qobra account, so their API keys are specific to your organization.
  1. Open Qobra settings > User attributes in the Qobra app.
  2. Locate the attribute you want (for example, a business unit attribute).
  3. Copy its API key. This is the exact key that appears in the GET /v1/users response for every user that has a value for that attribute.
Custom user attributes definition

Pagination

This endpoint is paginated using parameters offset and limit The “next” key in the response allow you to easily follow pagination to get the next batch of records

Variable api keys

This endpoint is based on dynamic fields. This mean that all annotations that look like <variable-key>, will have to or will be replaced by their actual API keys.

Authorizations

X-API-Key
string
header
required

Query Parameters

offset
integer
default:0

Optional (minimum:0 - maximum:9223372036854775807)

Required range: 0 <= x <= 9223372036854776000
limit
integer
default:2000

Optional (minimum:0 - maximum:2000): if set to 0 return total count only

Required range: 0 <= x <= 2000

Response

200 - application/json

Success operation

count
integer
required

Number of records in the response

data
UserModel · object[]
required
next
string

Next page of the response