User

Look up the GitHub account a user token belongs to.


Get the authenticated user #

GET /user

Get the id and login of the user the credential belongs to.

Mergify User Token GitHub Token Deprecated
200 Successful Response
idintegerrequired

The user's GitHub account id.

loginstringrequired

The user's GitHub login.

Example Response
                          {
  "id": 0,
  "login": "string"
}
                        
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_NOT_NEWER" | "API_VERSION_ROLLBACK_UNAVAILABLE" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_POLICY_INVALID_PATTERN" | "MERGE_QUEUE_POLICY_LIMIT_REACHED" | "MERGE_QUEUE_POLICY_NAME_TAKEN" | "MERGE_QUEUE_POLICY_NOT_FOUND" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_CACHE_ENTRIES_FILTER_REQUIRED" | "PIPELINE_CACHE_ENTRY_NOT_FOUND" | "PIPELINE_CACHE_NOT_ENABLED" | "PIPELINE_CACHE_NO_STORAGE_CONNECTION" | "PIPELINE_CACHE_READ_ONLY" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "STORAGE_POLICY_LIMIT_REACHED" | "STORAGE_POLICY_NAME_TAKEN" | "STORAGE_POLICY_NOT_FOUND" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_NOT_NEWER API_VERSION_ROLLBACK_UNAVAILABLE API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_POLICY_INVALID_PATTERN MERGE_QUEUE_POLICY_LIMIT_REACHED MERGE_QUEUE_POLICY_NAME_TAKEN MERGE_QUEUE_POLICY_NOT_FOUND MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_CACHE_ENTRIES_FILTER_REQUIRED PIPELINE_CACHE_ENTRY_NOT_FOUND PIPELINE_CACHE_NOT_ENABLED PIPELINE_CACHE_NO_STORAGE_CONNECTION PIPELINE_CACHE_READ_ONLY PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE STORAGE_POLICY_LIMIT_REACHED STORAGE_POLICY_NAME_TAKEN STORAGE_POLICY_NOT_FOUND SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 Forbidden
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/user" \
  -H "Authorization: Bearer <token>"

Was this page helpful?