Class OrganizationsManager

Hierarchy

  • BaseAPI
    • OrganizationsManager

Constructors

Properties

configuration: Configuration

Methods

  • List organization members.

    • Use the fields parameter to optionally define the specific member details retrieved. If fields is left blank, all fields (except roles) are returned.
    • Member roles are not sent by default. Use fields=roles to retrieve the roles assigned to each listed member. To use this parameter, you must include the read:organization_member_roles scope in the token.

    This endpoint supports two types of pagination:

    • Offset pagination
    • Checkpoint pagination

    Checkpoint pagination must be used if you need to retrieve more than 1000 organization members.

    Checkpoint Pagination

    To search by checkpoint, use the following parameters: - from: Optional id from which to start selection. - take: The total amount of entries to retrieve when using the from parameter. Defaults to 50. Note: The first time you call this endpoint using Checkpoint Pagination, you should omit the from parameter. If there are more results, a next value will be included in the response. You can use this for subsequent API calls. When next is no longer included in the response, this indicates there are no more pages remaining.

    Get members who belong to an organization

    Throws

    Parameters

    Returns Promise<ApiResponse<GetMembers200ResponseOneOf>>

  • Parameters

    Returns Promise<ApiResponse<GetMembers200ResponseOneOfInner[]>>