List users for an organization

GET

/organizations/{oid}/users

const url = 'https://apisandbox.puurk.com/organizations/example/users?status=active';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://apisandbox.puurk.com/organizations/example/users?status=active' \
  --header 'Authorization: Bearer <token>'

Returns users belonging to the specified organization

Authorizations

service_token

Parameters

Path Parameters

oid

required

string

Organization ID

Query Parameters

status

string

Allowed values: active terminated

Filter users by membership status

cursor

string

Pagination cursor

limit

integer

Number of results to return

Responses

200

Successful operation

application/json

object

data

Array<object>

object

Organization user document ID

string

uid

User ID

string

nullable

oid

Organization ID

string

nullable

status

string

nullable

Allowed values: active terminated

start_date

string format: date-time

nullable

termination_date

string format: date-time

nullable

commission_basis

string

nullable

Allowed values: profit retail

commission_fixed

Fixed commission amount in cents

integer

nullable

commission_rate

Commission rate

number

nullable

commission_trigger

string

nullable

Allowed values: sale service

puurk_trained_at

string format: date-time

nullable

pagination

object

limit

Maximum number of results returned

integer

hasMore

Whether more results are available

boolean

nextCursor

Cursor for the next page, or null if no more results

string

nullable

Example

{
  "data": [
    {
      "status": "active",
      "commission_basis": "profit",
      "commission_trigger": "sale"
    }
  ]
}

401

Unauthorized