API Reference

Katapult Core API

Resources & Endpoints

List organization users

This will return a simple list of users with any access to this organization. This endpoint is available to all users with access to the organization therefore allows them to see a small amount of information about their peers. This is useful when combined with other API actions that require the ID of a fellow user (such as when determining which users to assign a virtual machine). .

GET
https://api.katapult.io/core/v1/organizations/{organization}/users_with_access

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

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

organization Required

Organization Lookup None

page

Integer 1

per_page

Integer 30

Potential Errors

The following errors may occur during this request.

Details HTTP status

organization_not_activated

An organization was found from the arguments provided but it wasn't activated yet

 403 Forbidden

organization_not_found

No organization was found matching any of the criteria provided in the arguments

 404 Not Found

organization_suspended

An organization was found from the arguments provided but it was suspended

 403 Forbidden

Returned Object

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

{
    pagination: Pagination Details {
        current_page: Integer
        total_pages: Integer?
        total: Integer?
        per_page: Integer
        large_set: Boolean
    }
    users: [ OrganizationUser {
        user: User? {
            id: String
            first_name: String
            last_name: String
            avatar_url: String
        }
    } ]
}