NAME

OpenAPI::Client::OpenAI::Path::organization-users - Documentation for the /organization/users path.

DESCRIPTION

This document describes the API endpoint at /organization/users.

PATHS

GET /organization/users

Lists all of the users in the organization.

Operation ID

list-users

$client->list-users( ... );

Parameters

• limit (in query) (Optional) - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

  Type: integer

  Default: 20

• after (in query) (Optional) - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

  Type: string

• emails (in query) (Optional) - Filter by the email address of users.

  Type: array

Responses

Status Code: 200

Users listed successfully.

Content Types:

• application/json

  Example (See the OpenAI spec for more detail):

  {
     "data" : [
        "{\n    \"object\": \"organization.user\",\n    \"id\": \"user_abc\",\n    \"name\": \"First Last\",\n    \"email\": \"user@example.com\",\n    \"role\": \"owner\",\n    \"added_at\": 1711471533\n}\n"
     ]
  }

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.