Skip to main content
GET
/
settings
/
team
List Team Members
curl --request GET \
  --url https://staging-api.puppetvendors.com/settings/team \
  --header 'x-access-token: <api-key>'
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

​
Overview

Retrieve team members associated with the vendor account. Supports cursor-based pagination and free-text search.

​
Use Cases

  • Display a team management UI
  • Search for specific team members by name or email
  • Audit team access and permissions

​
Query Parameters

​
search
string
Free-text search across name and email. Maximum 200 characters.
​
first
number
Number of records to return from the start. Used with after for forward pagination.
​
after
string
Cursor for forward pagination. Use the endCursor from the previous response.
​
last
number
Number of records to return from the end. Used with before for backward pagination.
​
before
string
Cursor for backward pagination. Use the startCursor from the previous response.

​
Response

200
{
  "success": true,
  "data": {
    "edges": [
      {
        "cursor": "NjY1YTFiMmUzZDk4",
        "node": {
          "_id": "665a1b2e3d98f0001a2b3c80",
          "email": "alice@example.com",
          "profile": {
            "firstName": "Alice",
            "lastName": "Johnson",
            "phone": "+15125551234"
          },
          "apiPermissions": [
            "orders:read",
            "products:write"
          ],
          "createdAt": "2026-01-15T09:00:00.000Z",
          "lastLogin": "2026-05-18T14:22:00.000Z"
        }
      }
    ],
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": "NjY1YTFiMmUzZDk4",
      "endCursor": "NjY1YTFiMmUzZDk4"
    }
  }
}

​
Example

curl -X GET "https://staging-api.puppetvendors.com/settings/team?first=20&search=alice" \
  -H "x-access-token: YOUR_VENDOR_TOKEN"