View all methods

users.findByGithubUsername

Look up a user via their Github username.

Facts

Method GET https://api.getdx.com/users.findByGithubUsername
Required scope snapshots:read

Arguments

If looking up the team by team_id:

Name Type Description
token Token Auth token passed as an HTTP header.
github_username Text The GitHub username.

Example request

This is a typical request:

curl -X GET 'https://api.getdx.com/users.findByGithubUsername?github_username=johndoe' \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx'

Example response

This is a typical success response:

Example response

{
  "ok": true,
  "user": {
    "id": "user_123",
    "name": "John Doe",
    "email": "jon.doe@example.com",
    "tz": "America/Chicago",
    "slack_id": "slack_user_123"
  }
}