Users

Manage organization members

List Users

get

List users in the organization. Requires the 'users:read' scope.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Query parameters

limitnumber · min: 1 · max: 1000Optional

The number of results to return

Default: 100

offsetnumberOptional

The number of results to skip

Default: 0

Responses

200

Response for status 200

application/json

500

An unknown error occurred, trying again might help.

application/json

get

/v1/organization/users

HTTPcURLJavaScriptPython

GET /v1/organization/users HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": 1,
      "email": "text",
      "firstName": "text",
      "lastName": "text",
      "role": "ADMIN",
      "createdAt": "2025-12-22T02:12:05.664Z",
      "updatedAt": "2025-12-22T02:12:05.664Z"
    }
  ],
  "totalCount": 1,
  "offset": 1,
  "limit": 1
}

Update Organization Member

patch

Update an organization member's details. Requires the 'users:write' scope.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idnumber · min: 1Required

The ID of the user

Body

application/json

rolestring · enumRequiredPossible values:

Responses

200

Response for status 200

application/json

500

An unknown error occurred, trying again might help.

application/json

patch

/v1/organization/users/{id}

HTTPcURLJavaScriptPython

PATCH /v1/organization/users/{id} HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "role": "ADMIN"
}

{
  "id": 1,
  "email": "text",
  "firstName": "text",
  "lastName": "text",
  "role": "ADMIN",
  "createdAt": "2025-12-22T02:12:05.664Z",
  "updatedAt": "2025-12-22T02:12:05.664Z"
}

Remove User

delete

Remove a user from the organization. Requires the 'users:write' scope.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idnumber · min: 1Required

The ID of the user

Responses

200

Response for status 200

application/json

500

An unknown error occurred, trying again might help.

application/json

delete

/v1/organization/users/{id}

HTTPcURLJavaScriptPython

DELETE /v1/organization/users/{id} HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": 1
}