Space
objectA space represents a workspace for collaboration
Unique identifier for the space
Example:space_abc123
Space name
Example:My Workspace
Space profile picture URL
Example:https://cdn.insomnia.rest/spaces/space_abc123.png
First name of the space owner
Example:Jane
Last name of the space owner
Example:Doe
Email of the space owner
Example:jane@example.com
Count of current members
Example:12
Count of pending invitations
Example:3
Whether the authenticated user is the owner of this space
Example:true
Whether the authenticated user can leave this space
Organization
objectAn organization represents a logical grouping of spaces and users for access control and billing purposes
Unique identifier for the organization
Example:org_abc123
Organization name
Example:My Organization
The date and time the organization was created.
Example:2024-01-15T12:00:00Z
Error
objectstandard error
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.
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.
The error type.
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.
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.
UnauthorizedError
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.
Example:401
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.
Example:Unauthorized
The error type.
Example:https://httpstatuses.com/401
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.
Example:kong:trace:1234567890
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:Invalid credentials
CursorMetaPage
objectURI to the first page
URI to the last page
URI to the next page
URI to the previous page
Requested page size
Example:10