Me API

The Me API provides access to current user information, assigned records, and pending tasks. This endpoint serves as the primary interface for user-specific data and personal workspace functionality.

Core Functionality:

  • User Profile - Current user information including accounts and permissions
  • Assigned Records - All records assigned to the current user across different types
  • Task Management - Pending tasks assigned to the current user

User Context:

  • All endpoints return data scoped to the authenticated user
  • Account context is automatically determined from user session
  • Permissions are enforced based on user roles and project access

Response Structure:

  • User profile includes account memberships and role information
  • Assigned records include features, epics, requirements, ideas, releases, and tasks
  • Task lists include status information and completion tracking

Authentication: Standard API authentication (OAuth, session cookies, HTTP Basic until 2025). All operations require valid authentication and return user-specific data.

Get the current user profile

GET /api/v1/me

Retrieves current user information including account memberships and basic profile data

Parameters
NameDescription
include

Additional data to include in response (e.g., 'accounts', 'permissions')

Example request

GET /api/v1/me?include=%23%3CRSpec%3A%3AMatchers%3A%3ABuiltIn%3A%3AInclude%3A0x0000000336976830%3E

Example CURL command

curl -g "https://company.aha.io/api/v1/me?include=%23%3CRSpec%3A%3AMatchers%3A%3ABuiltIn%3A%3AInclude%3A0x0000000336976830%3E" -X GET \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab"

Request

contentType: application/json
accept: application/json
authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body