Organization

Methods for searching and retrieving organizations.

OrganizationClient

class muckrock.organizations.OrganizationClient

The organization client allows access to search, list, and retrieve individual organizations. Accessed generally as client.organizations.

list(self, **params)

List all organizations with optional filtering. Available filters include:

• name: Filter by the organization name.

• slug: Filter by the organization’s slug (URL identifier).

• uuid: Filter by the unique identifier for the organization.

Parameters:

params – Query parameters to filter results, such as name, slug, and uuid

Returns:

An APIResults object containing the list of organizations.

retrieve(self, organization_id)

Retrieve a specific organization by its ID.

Parameters:

organization_id – The unique ID of the organization to retrieve.

Returns:

An Organization object representing the requested organization.

Organization

class muckrock.organizations.Organization

A representation of a single organization.

str()

Return a string representation of the organization in the format Organization {id} - Name: {name}.

id

The numerical unique ID of the organization.

name

The name of the organization.

slug

The URL-friendly identifier (slug) for the organization.

uuid

The unique identifier for the organization (UUID format).

individual

A boolean indicating if the organization is an individual organization or not.

entitlement

The ID of the entitlements associated with the organization.

verified_journalist

A boolean indicating if the organization is verified as a journalist. This allows members of this organization to upload documents to DocumentCloud among other things.

users

A list of user IDs associated with the organization.