graphql.md

GraphQL API

Back to the navigation

Wraps GitHub v4 API (GraphQL API).

Execute a query

$rateLimits = $client->api('graphql')->execute($query);

Authentication

To use GitHub v4 API (GraphQL API) requests must authenticated.

$client->authenticate($token, null, Github\Client::AUTH_ACCESS_TOKEN);

$result = $client->api('graphql')->execute($query);

Use variables

Variables allow specifying of requested data without dynamical change of a query on a client side.

$query = <<<'QUERY'
query showOrganizationInfo (
  $organizationLogin: String!
) {
  organization(login: $organizationLogin) {
    name
    url
  }
}
QUERY;
$variables = [
    'organizationLogin' => 'KnpLabs'
];

$client->authenticate('<your-token>', null, Github\Client::AUTH_ACCESS_TOKEN);

$orgInfo = $client->api('graphql')->execute($query, $variables);