Get Managed Users

Retrieve the managed users you manage, with pagination support. (Admins see every partner’s managed users.)

GET /managed-users

TypeScript SDK

TypeScript

import { Configuration, ManagedUsersApi } from '@widgetic/api-sdk-ts';

const config = new Configuration({
  apiKey: 'YOUR_API_KEY'
});

const managedUsersApi = new ManagedUsersApi(config);

try {
  const response = await managedUsersApi.getAllManagedUsers({
    page: 1,
    size: 10
  });
  
  console.log('Managed users:', response.data);
  console.log('Total:', response.meta?.total);
  console.log('Current page:', response.meta?.page);
} catch (error) {
  if (error.response?.status === 401) {
    console.error('Authentication required');
  } else {
    console.error('Failed to fetch managed users:', error);
  }
}

200

{
  "success": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "managerId": "123e4567-e89b-12d3-a456-426614174001",
      "externalId": "external-user-123",
      "metadata": {
        "firstName": "John",
        "lastName": "Doe",
        "role": "editor"
      },
      "isActive": true,
      "createdAt": "2023-01-01T00:00:00Z",
      "updatedAt": "2023-01-02T00:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page · integer · default: 1

Page number for pagination

Required range: x >= 1

size · integer · default: 10

Number of items per page

Required range: 1 <= x <= 100

sort · string · default: createdAt:desc

Sort field and direction, <field>:<asc|desc>. The field is createdAt, updatedAt or externalId (the snake_case spellings created_at, updated_at and external_id work too); asc or desc alone sorts by createdAt. Any other field is a 400.

Response

200

application/json

Successful retrieval of managed users

success · boolean · required

data · object[] · required

Show child attributes

meta · object

Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.

Show child attributes