FIfiken
inbox

GET /companies/{companySlug}/inbox

Changed on

Returns the contents of the inbox for given company.

Request

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

Query parameters

pageinteger

Returns the number of the page to return. Valid page values are integers from 0 to the total number of pages. Default value is 0.

pageSizeinteger

Defines the number of entries to return on each page. Maximum number of results that can be returned at one time are 100. Default value is 25.

sortBy'createdDate asc' | 'createdDate desc' | 'name asc' | 'name desc'

Sorts results in either ascending (asc) or descending (desc) order based on the parameter value.

status'all' | 'unused' | 'used'

Filter documents based on their status. If not specified, all documents are returned.

namestring

Filter documents based on their name, case-insensitive substring match.

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