FIfiken
inbox

GET /companies/{companySlug}/inbox/{inboxDocumentId}

Changed on

Returns the inbox document with specified id

Request

  • Base URL
    https://api.fiken.no/api/v2
  • URL
    https://api.fiken.no/api/v2/companies/{companySlug}/inbox/{inboxDocumentId}
  • Auth
    OAuth 2
    Authorization code: https://fiken.no/oauth/authorize
    Token URL: https://fiken.no/oauth/token

Response

OK

documentIdinteger
namestring

Name of the document as it appears in the inbox

descriptionstring

Additional description of document

filenamestring

Name of the underlying file for the inbox document

statusboolean

Whether the document has been used as documentation or not

createdAtstring date-time

When the document was created

documentUrlstring

For use with API credentials (bearer token or oauth 2)

documentUrlWithFikenNormalUserCredentialsstring

Requires the user to login with username and password in Fiken.

Example response

{
  "documentId": 1234134
}

Changes

  • dff97b55851eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 4813e5666340Revision changes
    • info

      the endpoint scheme security fiken_api_oauth was removed from the API