GET
/
o
/
{organisation_id}
/
users
curl --request GET \
  --url https://platform.versori.com/api/v2/o/{organisation_id}/users \
  --header 'Authorization: Bearer <token>'
{
  "totalCount": 123,
  "next": "<string>",
  "prev": "<string>",
  "users": [
    {
      "id": "<string>",
      "externalId": "<string>",
      "displayName": "<string>",
      "organisationId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.

Path Parameters

organisation_id
string
required

Query Parameters

Search is a string that is used to filter the list of End Users. The search string is matched against the id, externalId and displayName fields.

activated
boolean

Filter users by their activation status. Must be used together with environment_id. If not provided, returns all users regardless of activation status.

environment_id
string

Filter users by activations in a specific environment. Must be used together with the 'activated' parameter. When combined with 'activated=true', it returns users that are activated in the specified environment. When combined with 'activated=false', it returns users that are not activated in this specific environment. If not provided, returns users from all environments.

Response

200
application/json

OK

The response is of type object.