Skip to main content
GET
/
v1
/
users
Fetch users
curl --request GET \
  --url https://api.qobra.co/v1/users \
  --header 'X-API-Key: <api-key>'
{
  "count": 4570,
  "data": [
    {
      "id": "5537a5b05d6e4824940e9e1bb9a5ebb8",
      "email": "john-doe@company.com",
      "name": "John Doe",
      "role": "Sales Rep",
      "currency": "EUR",
      "calculation_currency": "USD",
      "country": "France",
      "code": "AO32ND56",
      "...": "..."
    },
    "..."
  ],
  "next": "https://api.qobra.co/v1/users?limit=2000&offset=2000"
}

Documentation Index

Fetch the complete documentation index at: https://docs.qobra.co/llms.txt

Use this file to discover all available pages before exploring further.

​
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 users

​
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