Get user

GET

/api/v1/users/{id}

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/users/1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/users/1 \
  --header 'Authorization: Bearer <token>'

Retrieves a user.

Authorizations

OAuth2
users:read

Parameters

Path Parameters

required

integer

User ID

Responses

200

Successful

application/json

object

required

integer

first_name

required

string

last_name

required

string

email

required

string format: email

created_at

required

string format: date-time

updated_at

required

string format: date-time

profile_image_url

required

string format: url

nullable

wants_marketing_emails

required

boolean

two_factor_enabled

required

boolean

disabled_email_notifications

required

Array<string>

Allowed values: mentioned_in_comment reply_in_comment_thread requested_review review_changes_requested review_approved ready_to_publish

organization_membership

required

object

role_id

required

integer

invitation_sent_at

required

string format: date-time

nullable

invitation_accepted_at

required

string format: date-time

nullable

Example

{
  "id": 12345,
  "first_name": "Joe",
  "last_name": "Cottam",
  "email": "joe@example.com",
  "created_at": "2023-08-23T10:30:00.000Z",
  "updated_at": "2023-08-23T10:30:00.000Z",
  "profile_image_url": "https://example.com/profile.jpg",
  "wants_marketing_emails": false,
  "two_factor_enabled": false,
  "disabled_email_notifications": [
    "mentioned_in_comment"
  ],
  "organization_membership": {
    "role_id": 12345,
    "invitation_sent_at": "2023-08-23T10:30:00.000Z",
    "invitation_accepted_at": "2023-08-23T10:30:00.000Z"
  }
}