API Reference

Katapult Core API

Resources & Endpoints

Get current user details

This endpoint returns details for the currently authenticated user. If the API token used to authenticate to the API is not associated with a user, this method will return an error. .

GET
https://api.katapult.io/core/v1/users/current

If successful, this endpoint will return a 200 OK status.

Potential Errors

The following errors may occur during this request.

Details HTTP status

no_user_associated_with_identity

There is no user associated with this API token

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    user: User {
        id: String
        first_name: String
        last_name: String
        avatar_url: String
    }
    organizations: [ Organization {
        id: String
        name: String
        sub_domain: String
    } ]
    api_token_id: String?
}