> ## Documentation Index > Fetch the complete documentation index at: https://developers.everhour.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Current User > Retrieve the user that owns the API key. Returns every field of the team member object plus personal settings: timezone, date and time formats, time off permissions, connected integration accounts, and the full team object. ## OpenAPI ````yaml /openapi.json get /users/me openapi: 3.1.1 info: title: Everhour API version: 1.0.0 license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.everhour.com security: - ApiKeyAuth: [] tags: - name: Clients - name: Custom Fields - name: Expenses - name: Invoices - name: Projects - name: Reports - name: Schedule - name: Tasks - name: Time Off - name: Time Records - name: Timecards - name: Timers - name: Timesheets - name: Users - name: Webhooks paths: /users/me: get: tags: - Users summary: Get Current User description: >- Retrieve the user that owns the API key. Returns every field of the team member object plus personal settings: timezone, date and time formats, time off permissions, connected integration accounts, and the full team object. operationId: getCurrentUser responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CurrentUser' '401': description: Unauthorized components: schemas: CurrentUser: allOf: - $ref: '#/components/schemas/User' - type: object description: >- Every field of the team member object, plus the settings below that only the authenticated user sees. The response also carries onboarding and UI state fields that are internal to the Everhour apps — do not rely on them. properties: timezone: type: number description: UTC offset in hours (e.g. -5, 5.5). example: 3 apiKey: type: string description: >- The user's personal API key — the same key used in the `X-Api-Key` header. isSuspended: type: boolean example: false hasPassword: type: boolean description: >- `false` when the user signs in through SSO or a connected account only. example: true dateFormat: type: integer description: Code for the user's date format. example: 1 dateTimeFormat: type: integer description: Code for the user's date and time format. example: 12 timeFormat: type: integer description: Code for the user's duration format. example: 1 exportTimeFormat: type: integer description: Code for the duration format used in exports. example: 4 exportCsvSeparator: type: integer description: Code for the column separator used in CSV exports. example: 1 timeRounding: type: integer description: Code for the rounding interval applied to time entries. example: 1 timeRoundingDirection: type: string description: How rounding is applied. example: nearest startPage: type: string description: Page the user lands on after signing in. example: time activityMode: type: string example: detailed country: type: string description: ISO 3166-1 alpha-2 country code. timeOffPermissions: type: object description: What the user may do with time off. properties: read: type: string example: all write: type: string example: request notificationSettings: type: object description: Email and push notification preferences. clockOutSettings: type: object description: Automatic clock-out preferences. accounts: type: array description: >- Integration accounts connected to the user, such as Asana or GitHub. items: type: object properties: id: type: string example: as:1185184465308295 platform: type: string description: >- Two-letter platform code, for example `as` (Asana) or `gh` (GitHub). example: as name: type: string example: John Bender email: type: string example: john.bender@example.com status: type: string example: active createdAt: type: string example: '2020-07-20 09:39:09' team: $ref: '#/components/schemas/Team' rate: type: integer description: Hourly bill rate in cents (admins only). example: 5000 User: type: object description: >- A team member. `GET /team/users` and `GET /users/me` return the full object; `user` objects nested in other resources may contain a subset of these fields. properties: id: type: number example: 1304 email: type: string example: john.bender@example.com name: type: string example: John Bender headline: type: - string - 'null' description: Job title. Empty string when not set. example: CEO phone: type: string description: Omitted when not set. example: +1 555 0100 externalId: type: string description: >- Employee ID from your own system, set on the member profile. Omitted when not set. example: M-3490 avatarUrl: type: - string - 'null' description: Omitted when the member has no avatar. example: https://d36887svjhykt4.cloudfront.net/users/1304-15ea197d07ca81.jpg avatarUrlLarge: type: - string - 'null' description: Omitted when the member has no avatar. example: https://d36887svjhykt4.cloudfront.net/users/1304-15ea197d10830c.jpg role: type: string enum: - admin - supervisor - member - member_limited example: admin status: type: string enum: - active - invited - pending - removed example: active type: type: string enum: - employee - contractor example: employee createdAt: type: string description: 'Format: Y-m-d H:i:s' example: '2016-08-13 15:27:30' isEmailVerified: type: boolean example: true capacity: type: - integer - 'null' description: Weekly capacity in seconds. example: 144000 cost: type: integer description: >- Hourly cost in cents. Returns `0` when you lack the `costs` permission. example: 2500 costHistory: type: - array - 'null' description: >- Past hourly cost values. `null` when the member has no cost history or you lack the `costs` permission. example: null groups: type: array description: >- Groups the member belongs to. Empty array when the member is in no group. items: $ref: '#/components/schemas/UserGroup' permissions: $ref: '#/components/schemas/UserPermissions' timeTrackingPolicy: $ref: '#/components/schemas/TimeTrackingPolicy' resourcePlannerAccess: $ref: '#/components/schemas/ResourcePlannerAccess' favorite: type: boolean description: Whether you marked this member as a favorite. example: false required: - id - email - name - role - status - type - createdAt - isEmailVerified - groups - permissions - timeTrackingPolicy - favorite Team: type: object description: The team the user belongs to. Returned by `GET /users/me`. properties: id: type: number example: 2 name: type: string example: Acme Inc createdAt: type: string description: 'Format: Y-m-d H:i:s' example: '2016-08-13 18:10:36' logoUrl: type: string example: https://d36887svjhykt4.cloudfront.net/teams/2-16a7d93a236d9b.jpg owner: type: object description: The team owner. properties: id: type: number example: 7 name: type: string example: Jane Doe headline: type: string example: CPO workdays: type: array description: Working days of the week. items: type: string example: - MON - TUE - WED - THU - FRI beginningOfWeek: type: integer description: Code for the first day of the week. example: 1 workHoursFrom: type: string description: Start of the working day, `HH:MM`. example: '09:00' workHoursTo: type: string description: End of the working day, `HH:MM`. example: '18:00' workTimeMin: type: integer description: Minimum expected working time per day, in seconds. example: 23400 workTimeMax: type: integer description: Maximum expected working time per day, in seconds. example: 30600 allowFutureTracking: type: boolean example: false lockTimeEnabled: type: boolean example: true lockTimeAfter: type: integer description: Number of `lockTimePeriod` units after which time entries lock. example: 2 lockTimePeriod: type: string description: Unit used by `lockTimeAfter`. example: days defaultRate: type: integer description: Default hourly bill rate for new members, in cents. example: 5000 defaultCost: type: integer description: Default hourly cost for new members, in cents. example: 2500 defaultCapacity: type: integer description: Default weekly capacity for new members, in seconds. example: 144000 currencyDetails: $ref: '#/components/schemas/TeamCurrency' billing: $ref: '#/components/schemas/TeamBilling' planFeatures: type: object description: >- Feature flags for the team's plan, such as `invoicing`, `timeOff`, or `api`. Each flag is a boolean, except `allowedIntegrations`, which lists two-letter platform codes. applications: type: object description: >- Which Everhour applications the team has turned on, such as `timecards` or `resourcePlanner`, plus the member IDs they apply to. timeOffPermissions: type: object description: Team-wide defaults for who may read and request time off. properties: read: type: string example: all write: type: string example: request UserGroup: type: object description: A group the user belongs to. properties: id: type: number example: 1 name: type: string example: Admins required: - id - name UserPermissions: type: object description: >- Areas the user can access beyond the base role. A key is present only when the user has access to that area. Users with no elevated access return an empty array (`[]`) instead of an object — treat both as "no permissions". properties: billingBudgets: type: string enum: - read - write example: write userLimits: type: string enum: - read - write example: write costs: type: string enum: - read - write example: write invoices: type: string enum: - read - write example: write expenses: type: string enum: - read - write example: write TimeTrackingPolicy: type: object description: >- Time tracking rules that apply to the user. Team defaults unless the team overrides them for this member. properties: allowTimeWithoutTask: type: boolean example: true allowManualTimeInput: type: boolean example: true allowFutureTime: type: boolean example: false allowCompletedTaskTime: type: boolean example: true allowTimeWithoutEstimate: type: boolean example: true allowExceedEstimate: type: boolean example: false allowManageEstimates: type: boolean example: true lockTimeAfter: type: integer description: >- Number of `lockTimePeriod` units after which time entries lock. Present only when the team locks time for this member. example: 2 lockTimePeriod: type: string description: >- Unit used by `lockTimeAfter`. Present only when the team locks time for this member. example: days ResourcePlannerAccess: type: object description: Resource planner access flags. Returned for the authenticated user. properties: viewMine: type: boolean example: false editMine: type: boolean example: false viewAll: type: boolean example: false editAll: type: boolean example: false TeamCurrency: type: object description: The team's currency. properties: code: type: string description: ISO 4217 currency code. example: USD name: type: string example: US Dollar symbol: type: string example: $ TeamBilling: type: object description: Subscription details for the team. properties: plan: type: string example: team_monthly status: type: string example: paid seats: type: integer description: Seats the team pays for. example: 18 quantity: type: integer description: Seats currently in use. example: 18 paidPeriodEnd: type: string description: 'End of the paid period. Format: Y-m-d H:i:s' example: '2026-10-07 10:00:53' trialEndedAt: type: - string - 'null' description: 'Format: Y-m-d H:i:s' example: '2018-08-03 10:26:27' billingEmail: type: string example: billing@example.com canManageSeats: type: boolean example: true securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-Api-Key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.