Users

User lookup by id, email, or me.

Namespace: Goodmem.Client.Api · Class: UsersApi

Reach this surface as client.Users on a GoodmemClient. Every network method is asynchronous — it returns a Task<T> (or an IAsyncEnumerable<T> for pagination and streaming) and accepts a CancellationToken; the Async suffix marks the standard .NET Task-based async pattern.

Methods

GetAsync

Retrieves a user by ID or email address. Exactly one of id and email must be provided.

Declaration

public Task<UserResponse> GetAsync(UsersGetOptions options, CancellationToken ct = default)

HTTP — GET /v1/users/{id}

Parameters

Returns

Task<UserResponse> — an awaitable that resolves to UserResponse.

Exceptions

Examples

Example 1:

var user = await client.Users.GetAsync(new UsersGetOptions { Id = "your-user-id" });
Console.WriteLine(user.Email);

Example 2:

// Or look a user up by email instead of ID.
var user = await client.Users.GetAsync(
    new UsersGetOptions { Email = "[email protected]" }
);
Console.WriteLine(user.UserId);

MeAsync

Retrieves the authenticated user's profile information including email, display name, and creation time. This endpoint does not require any parameters as it automatically returns the caller's information.

Declaration

public Task<UserResponse> MeAsync(CancellationToken ct = default)

HTTP — GET /v1/users/me

Parameters

Returns

Task<UserResponse> — an awaitable that resolves to UserResponse.

Exceptions

Example

var user = await client.Users.MeAsync();
Console.WriteLine($"{user.Email} {user.UserId}");

Data Models

Types in the Goodmem.Client.Models namespace. Each row lists the C# property, its type, the JSON wire name, and a description.

UserResponse

User information response