Users API

Documentation on how to use the users API via OAuth2 in SePay.

Introduction

SePay’s users API allows you to access information about the current user and their company. You can retrieve the user’s personal information and detailed information about the company they belong to.
To use this API, your Access Token must include the profile scope (for user information) or the company scope (for company information).

Get user information

GET

/api/v1/me

Authorization: Bearer {YOUR_ACCESS_TOKEN}

This endpoint returns information about the currently authenticated user via OAuth2.
Required permissions
- Scope: profile

RESPONSE

{
  "status": "success",
  "data": {
    "id": 1234,
    "first_name": "Nguyễn",
    "last_name": "Văn A",
    "email": "nguyen.van.a@example.com",
    "phone": "0901234567",
    "avatar": "https://www.gravatar.com/avatar/0bc83cb571cd1c50ba6f3e8a78ef1346"
  }
}

idinteger

User ID

first_namestring

User's first name

last_namestring

User's last name

emailstring

User's email address

phonestring

User's phone number

avatarstring

Avatar URL fetched from Gravatar

Error codes

Below are possible error codes when using the users API:
HTTP Code Error Code Description
401
unauthorized
Token is invalid or expired
403
forbidden
You do not have permission to access this resource

HTTP Code	Error Code	Description
401	unauthorized	Token is invalid or expired
403	forbidden	You do not have permission to access this resource