Class OrgResource

constructor

• new OrgResource(http: HttpClient): OrgResource

  Parameters

  • http: HttpClient

  Returns OrgResource

Readonlythreads

artifacts

• artifacts(
      org: string,
      params?: {
          afterCursor?: string;
          groupKey?: string;
          groupKeyPrefix?: string;
          limit?: number;
      },
  ): Promise<
      {
          after_cursor?: string
          | null;
          before_cursor?: string | null;
          data: {
              agent?: string;
              content_type?: string;
              created_at?: string;
              current_version?: string;
              description?: string;
              file?: string;
              file_name?: string;
              file_url?: string;
              group_key?: string | null;
              id: string;
              image_source?: {
                  file?: string | null;
                  height?: number | null;
                  media?: string | null;
                  mime_type?: string | null;
                  refresh_url?: string | null;
                  url?: string | null;
                  width?: number | null;
              };
              name?: string;
              org?: string;
              sandbox?: string;
              system?: boolean;
              team?: string;
              thread?: string;
              updated_at?: string;
              user?: string;
              version?: number;
          }[];
          has_more: boolean;
      },
  >

  List completed organization artifacts Returns completed system-owned organization snapshots, newest first. Private user, team, agent and thread artifacts are excluded.

  Parameters

  • org: string

    Organization ID.

  • Optionalparams: {
        afterCursor?: string;
        groupKey?: string;
        groupKeyPrefix?: string;
        limit?: number;
    }

    Query parameters.

    • OptionalafterCursor?: string

      Opaque cursor for the next page of older snapshots.

    • OptionalgroupKey?: string

      Exact, case-sensitive grouping key.

    • OptionalgroupKeyPrefix?: string

      Nonempty literal group prefix; mutually exclusive with group_key.

    • Optionallimit?: number

      Maximum snapshots returned, from 1 to 100.

  Returns Promise<
      {
          after_cursor?: string
          | null;
          before_cursor?: string | null;
          data: {
              agent?: string;
              content_type?: string;
              created_at?: string;
              current_version?: string;
              description?: string;
              file?: string;
              file_name?: string;
              file_url?: string;
              group_key?: string | null;
              id: string;
              image_source?: {
                  file?: string | null;
                  height?: number | null;
                  media?: string | null;
                  mime_type?: string | null;
                  refresh_url?: string | null;
                  url?: string | null;
                  width?: number | null;
              };
              name?: string;
              org?: string;
              sandbox?: string;
              system?: boolean;
              team?: string;
              thread?: string;
              updated_at?: string;
              user?: string;
              version?: number;
          }[];
          has_more: boolean;
      },
  >

  Successful response

linkedAccounts

• linkedAccounts(
      org: string,
      params?: { afterCursor?: string; limit?: number; user?: string[] },
  ): Promise<
      {
          after_cursor?: string
          | null;
          before_cursor?: string | null;
          data: { account_id: string; provider: string; user: string }[];
          has_more: boolean;
      },
  >

  List an organization's linked accounts Returns the GitHub login each user in the organization signed in with, so clients can tell that a pull request's author and a Platform user are the same person. Users who never signed in with GitHub are absent. Any viewer acting within the organization can list them; other viewers get 404. Pass user to look up specific users instead of listing the whole organization. Results are ordered by user and paginated forward with after_cursor.

  Parameters

  • org: string

    Organization ID (org_...) whose linked accounts should be listed.

  • Optionalparams: { afterCursor?: string; limit?: number; user?: string[] }

    Query parameters.

    • OptionalafterCursor?: string

      Opaque cursor for the next page.

    • Optionallimit?: number

      Maximum accounts returned, from 1 to 100.

    • Optionaluser?: string[]

      Up to 100 user IDs (usr_...) to look up. Omit to list every user in the organization. Users in the list who are outside the organization or have no linked account are absent.

  Returns Promise<
      {
          after_cursor?: string
          | null;
          before_cursor?: string | null;
          data: { account_id: string; provider: string; user: string }[];
          has_more: boolean;
      },
  >

  Successful response

list

• list(
      params?: { page?: number; pageSize?: number; search?: string },
  ): Promise<
      {
          data: {
              domain?: string;
              id: string;
              kind: "personal"
              | "company";
              name: string;
          }[];
          has_next?: boolean;
          has_prev?: boolean;
          page?: number;
          page_size?: number;
          total_entries?: number;
          total_pages?: number;
      },
  >

  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;
              kind: "personal"
              | "company";
              name: string;
          }[];
          has_next?: boolean;
          has_prev?: boolean;
          page?: number;
          page_size?: number;
          total_entries?: number;
          total_pages?: number;
      },
  >

  Successful response