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