@archastro/sdk
    Preparing search index...

    Class OrgResource

    Index

    Constructors

    constructor

    Methods

    list

    Constructors

    Methods

    • Search organizations Returns a paginated list of organizations within the authenticated app scope, optionally filtered by a free-text search term matched against name, slug, and domain (case-insensitive). Results are ordered by relevance when a search term is provided, and by creation time descending otherwise. The response includes only public-facing organization fields: ID, name, domain, and logo. Use the developer-scoped org endpoints to access full organization records. Pagination is offset-based. Pass page and page_size to navigate through results. The has_next and has_prev fields indicate whether adjacent pages exist.

      Parameters

      • Optionalparams: { page?: number; pageSize?: number; search?: string }

        Query parameters.

        • Optionalpage?: number

          Page number to retrieve, starting at 1. Defaults to 1 when omitted.

        • OptionalpageSize?: number

          Number of organizations to return per page. Defaults to 25; maximum is 100.

        • Optionalsearch?: string

          Free-text search term matched against organization name, slug, and domain (case-insensitive). Omit to return all organizations in the app.

      Returns Promise<
          {
              data: { domain: string; id: string; name: string }[];
              has_next?: boolean;
              has_prev?: boolean;
              page?: number;
              page_size?: number;
              total_entries?: number;
              total_pages?: number;
          },
      >

      Successful response

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods