GitHub GraphQL クエリ例: 組織の情報を取得する (organization)

更新: 2022-06-20 / 作成: 2020-09-14

GitHub GraphQL API で指定した組織の情報を（ここでは github organization）の情報を取得には、organization クエリを使用します。 organization クエリには、login パラメーターで組織名を渡します。

organization クエリが返す Organization オブジェクトを参照すると、そこに所属する メンバーの一覧、チームの一覧、リポジトリの一覧 などを取得することができます。

ある組織に所属するユーザー情報を取得する (Organization.membersWithRole)

Organization オブジェクトの membersWithRole フィールドは OrganizationMemberConnection オブジェクトを保持しており、この nodes を参照することで、組織に所属するメンバーの一覧を取得できます。

GraphQL クエリ

query {
  organization(login: "github") {
    name
    description
    url
    membersWithRole(first: 3) {
      nodes {
        login
        name
        email
        updatedAt
      }
    }
  }
}

実行結果

{
  "data": {
    "organization": {
      "name": "GitHub",
      "description": "How people build software.",
      "url": "https://github.com/github",
      "membersWithRole": {
        "nodes": [
          {
            "login": "mtodd",
            "name": "Matt Todd",
            "email": "xxx@example.com",
            "updatedAt": "2022-05-28T16:13:01Z"
          },
          {
            "login": "jonmagic",
            "name": "Jonathan Hoyt",
            "email": "xxx@example.com",
            "updatedAt": "2022-06-07T18:27:30Z"
          },
          {
            "login": "mislav",
            "name": "Mislav Marohnić",
            "email": "xxx@example.com",
            "updatedAt": "2022-04-07T18:34:52Z"
          }
        ]
      }
    }
  }
}

ある組織のリポジトリの一覧を取得する (Organization.repositories)

Organization オブジェクトの repositories フィールドを参照することで、その組織に作成されたリポジトリの一覧を取得することができます。

GraphQL クエリ

query {
  organization(login: "github") {
    name
    description
    url
    repositories(first: 3) {
      nodes {
        name
        url
      }
    }
  }
}

実行結果

{
  "data": {
    "organization": {
      "name": "GitHub",
      "description": "How people build software.",
      "url": "https://github.com/github",
      "repositories": {
        "nodes": [
          {
            "name": "media",
            "url": "https://github.com/github/media"
          },
          {
            "name": "albino",
            "url": "https://github.com/github/albino"
          },
          {
            "name": "hubahuba",
            "url": "https://github.com/github/hubahuba"
          }
        ]
      }
    }
  }
}