API Reference

Katapult Core API

Resources & Endpoints

Lookup Argument Set

Organization Lookup

Provides for organizations to be looked up.

Arguments

Any one of the following arguments can be provided for this lookup argument set. An error will be raised if none or more than one argument value is provided.

Name Type Default Value

id

String None

sub_domain

String None

Potential errors

Any of the following errors may be encountered when looking up the object.

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