Fishbowl
Fishbowl Advanced REST API Documentation

Login

The Login call allows you to log in to the Fishbowl Server. This should be the first call as it will return the session information that will be used in all subsequent calls. The logged in user will determine the access rights for calls made during the session. Logout to close the session.

Related guide: Starting Fishbowl

ENDPOINTS
POST /api/login
POST /api/logout
Logging in to Fishbowl

This logs the user in to Fishbowl and returns the list of Access Rights. The first time your Integrated App logs in, you'll need to approve the App in Fishbowl. If the user has enabled MFA (multi-factor authentication), the response will return HTTP 401 with a response header "MFA: Required". Resend the same request object with the mfaCode field included to log in.

Related guide: Approving Integrations

Attributes
  • appName string
    The name of your application.
  • appDescription string
    A brief description of what your application does.
  • appId integer
    The unique identifier for your integrated application. Use any number you want, but we recommend at least 4 digits in length.
  • username string
    The username of the user logging in.
  • password string
    The user's password.
  • mfaCode string optional
    The TOTP code from the user's authenticator app. Required if the user has enabled MFA (multi-factor authentication).
POST /api/login 
curl --location \
--request POST '<YOUR SERVER>/api/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appName": "App Name",
    "appDescription": "my description",
    "appId": 12345,
    "username": "JohnSmith",
    "password": "password12345",
    "mfaCode": "123456"
}'
RESPONSE
{
  "token": "7dd6bcf7-5e92-4c25-86c9-54af4a831d54",
  "user": {
    "id": 5,
    "userFullName": "John Smith",
    "moduleAccessList": [
      "Company",
      "Customer",
      "Payment Receipt",
      "Dashboard",
      "Product",
      "Home",
      "Property",
      "Custom Field",
      "Receiving",
      "Payment Gateway",
      "Calendar",
      "RMA",
      "Reports",
      "Data",
      "Sales Order Invoice",
      "Vendor",
      "Location Group",
      "UOM",
      "Part Label",
      "Schedule",
      "Memo",
      "Location"
    ],
    "serverVersion": "20.11.20201111"
  }
}
Logging out of Fishbowl

This logs the user out of Fishbowl, ending the current session.

Attributes

    No attributes.

POST /api/logout 
curl --location --request POST '<YOUR SERVER>/api/logout' \
--header 'Authorization: Bearer <TOKEN>'
RESPONSE
{}