Authenticate to get a valid token

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Notice to Ferret API (v1) users

We’re excited to announce the beta release of Ferret API v2, offering a more consistent and expanded approach, with access to a wider range of objects.

New clients are encouraged to start with Ferret API v2 and/or Octopus API to take advantage of the latest updates. Existing clients are also encouraged to transition to v2, although Ferret API v1 will remain stable and fully operational. For those looking to migrate to the Octopus API, we’ve prepared a detailed migration guide.

Body Params

Command to authenticate

string | null

Database of the customer to be used

string | null

Customer's unique id

string | null

Customer's password

string | null

Vendor id

string | null

Application key

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json