UserEmail

object

An email address associated with a user

emailstring(email)required

The email address

Example:jane.doe@example.com

is_primarybooleanrequired

Whether this is the user’s primary email

Example:true

Example

UserUpdate

object

Fields that can be updated on a user profile

first_namestring

The user’s first name

Example:Jane

last_namestring

The user’s last name

Example:Doe

Example

Space

object

A space represents a workspace for collaboration

idstringrequired

Unique identifier for the space

Example:space_abc123

namestringrequired

Space name

Example:My Workspace

picturestring(uri)

Space profile picture URL

Example:https://cdn.insomnia.rest/spaces/space_abc123.png

owner_first_namestring

First name of the space owner

Example:Jane

owner_last_namestring

Last name of the space owner

Example:Doe

owner_emailstring(email)

Email of the space owner

Example:jane@example.com

total_membersintegerrequired

Count of current members

Example:12

total_invitesintegerrequired

Count of pending invitations

Example:3

is_ownerboolean

Whether the authenticated user is the owner of this space

Example:true

can_leaveboolean

Whether the authenticated user can leave this space

Example

Organization

object

An organization represents a logical grouping of spaces and users for access control and billing purposes

idstringrequired

Unique identifier for the organization

Example:org_abc123

namestring

Organization name

Example:My Organization

created_atstring(date-time)required

The date and time the organization was created.

Example:2024-01-15T12:00:00Z

Example

Error

object

standard error

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example