People V2
Organization V2

Get organization people list

Returns a paginated list of people in an organization.

get/v2/organization/{organizationName}/people-list

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v2/organization/{organizationName}/people-list
  • Auth: HTTP bearer

Path parameters

organizationNamestring required

Organization slug/name

Example:zephyr-cloud

Query parameters

pageinteger

Page number

Example:1
perPageinteger

Items per page

Example:20
namestring

Filter by name or email (partial match)

Example:john

Response

People list retrieved successfully

peopleLimitExceededboolean required

Whether the seats limit has been exceeded

Example response

{
  "entities": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "John Doe",
      "email": "john@example.com",
      "username": "johndoe",
      "role": "editor",
      "avatarColor": "#3B82F6"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.