Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 6.9 KB

README.md

File metadata and controls

53 lines (35 loc) · 6.9 KB

ExternalOrganizations

(external_organizations)

Overview

Available Operations

  • list - List External Organizations

list

List external organizations.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.external_organizations.list()

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
platform OptionalNullable[models.PlatformFilter] ➖ Filter by platform.
name OptionalNullable[models.RepositoryNameFilter] ➖ Filter by name.
organization_id OptionalNullable[models.OrganizationIDFilter] ➖ Filter by organization ID.
page Optional[int] ➖ Page number, defaults to 1.
limit Optional[int] ➖ Size of a page, defaults to 10. Maximum is 100.
sorting List[models.ExternalOrganizationSortProperty] ➖ Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ExternalOrganizationsListResponse

Errors

Error Type Status Code Content Type
models.HTTPValidationError 422 application/json
models.SDKError 4XX, 5XX */*