3.1.4OAS 3.0

The API for Insomnia.

API Base URL
  • Server 1:https://api.insomnia.rest/v3

    Base URL for the Insomnia API

Security
sessionTokenHeader (apiKey)

An API key is a token that you provide when making API calls. Include the token in a header parameter called X-Session-ID.

Example: X-Session-ID: 123

sessionTokenCookie (apiKey)

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called __Host-Insomnia-Session-ID.

Example: __Host-Insomnia-Session-ID: 123

oktaOAuth (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Additional Information
Contact Kong

Get ping

Get a simple ping response to verify that the v3 Insomnia API is wired up end-to-end.

get
https://api.insomnia.rest/v3/ping

Response

application/json

Successful pong response

pingstringrequired

Example:pong

get/ping
 
application/json

List users

Retrieve all users matching the provided filters.

get
https://api.insomnia.rest/v3/users

Query Parameters

emailstring(email)required

Filter users by exact email address.

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Response

application/json

A list response for users

* Additional properties are NOT allowed.
dataarray[object]required

The user’s full profile

Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
get/users
 
application/json

Get user

Retrieve the profile of the specified user.

get
https://api.insomnia.rest/v3/users/{userId}

Path Parameters

userIdstringrequired

The user ID

Example:usr_abc123

Response

application/json

A single user profile response

User

The user’s full profile

idstringrequiredread-only

Unique identifier for the user

Example:usr_abc123

first_namestringrequired

The user’s first name

Example:Jane

last_namestringrequired

The user’s last name

Example:Doe

picturestring(uri)

URL to the user’s profile picture

Example:https://cdn.insomnia.rest/avatars/usr_abc123.jpg

emailstring(email)required

The email address

Example:jane.doe@example.com

emailsarray[object]requiredread-only

An email address associated with a user

Show Child Parameters
is_externally_provisionedbooleanrequiredread-only

Indicates the user was provisioned externally (e.g., via SCIM). When true, profile fields (first_name, last_name, email, emails, picture) cannot be updated by the user.

Example:false

encryption_enabledbooleanrequiredread-only

Whether end-to-end encryption is enabled for this user

Example:false

created_atstring(date-time)requiredread-only

The date and time the user account was created

Example:2024-01-15T08:30:00Z

get/users/{userId}
 
application/json

Update current user

Update the profile of the currently authenticated user.
All fields are optional - only provided fields will be updated.

patch
https://api.insomnia.rest/v3/users/me

Body

application/json

UserUpdate

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

Response

application/json

A single user profile response

User

The user’s full profile

idstringrequiredread-only

Unique identifier for the user

Example:usr_abc123

first_namestringrequired

The user’s first name

Example:Jane

last_namestringrequired

The user’s last name

Example:Doe

picturestring(uri)

URL to the user’s profile picture

Example:https://cdn.insomnia.rest/avatars/usr_abc123.jpg

emailstring(email)required

The email address

Example:jane.doe@example.com

emailsarray[object]requiredread-only

An email address associated with a user

Show Child Parameters
is_externally_provisionedbooleanrequiredread-only

Indicates the user was provisioned externally (e.g., via SCIM). When true, profile fields (first_name, last_name, email, emails, picture) cannot be updated by the user.

Example:false

encryption_enabledbooleanrequiredread-only

Whether end-to-end encryption is enabled for this user

Example:false

created_atstring(date-time)requiredread-only

The date and time the user account was created

Example:2024-01-15T08:30:00Z

patch/users/me

Body

{}
 
application/json