aventra.Developers
API referenceConnection

Find workspace users

Find Aventra workspace users by email or browse the directory. Use their UUIDs to assign CRM tasks, company records and sales offers.

Permissions: Read access to at least one CRM resource.

Behavior and retry rules

Use email to match an address (case-insensitive, except addresses containing a literal asterisk). No match returns an empty data array. Query values must be URL encoded. Without email, results are ordered by UUID. Use limit (1–100, default 25) and offset (0–10000) and follow page.has_more. Only IDs, names and email addresses from your own workspace are returned.

GET/users

Authorization

bearerAuth
AuthorizationBearer <token>

Create a key in Aventra → Innstillinger → API-nøkler.

In: header

Query Parameters

email?string
Formatemail
limit?integer
Range1 <= value <= 100
Default25
offset?integer
Range0 <= value <= 10000
Default0

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/users?email=ola%40example.com" \  -H "Authorization: Bearer $AVENTRA_API_KEY"
{  "data": [    {      "id": "f52b3fd3-5ff4-4d93-91c5-6ac79e21cdd5",      "email": "ola@example.com",      "first_name": "Ola",      "last_name": "Nordmann"    }  ],  "page": {    "size": 25,    "offset": 0,    "has_more": false  }}

See authentication, errors and retry guidance.

Responses & errors

Handle Aventra CRM API responses and errors, from validation and permissions to rate limits, missing records and retry decisions.

Check your connection

Verify your Aventra CRM API connection and read the workspace, key creator and permission mask associated with the current Bearer key.