FIfiken
companies

GET /companies

Changed on

Returns all companies from the system that the user has access to. The user can update which companies a given app has access to in Fiken under Brukerinnstillinger -> Sikkerhet -> Apper du har gitt tilgang til.

Request

  • Base URL
    https://api.fiken.no/api/v2
  • URL
    https://api.fiken.no/api/v2/companies
  • 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' | 'organizationNumber asc' | 'organizationNumber desc'

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

Response

OK

namestring

Name of company.

slugstring

Formatted name of company. This is the companySlug that should be used in all URLs related to this company.

organizationNumberstring

Brreg organization number.

vatType'no' | 'yearly' | 'monthly' | 'bi-monthly'
phoneNumberstring
emailstring
creationDatestring date
hasApiAccessboolean
testCompanyboolean

Whether the company is a demo (true) or not

accountingStartDatestring date
vatRegistrationDatestring date

Example response

[
  {
    "name": "Swagger test company",
    "slug": "swagger-test-company",
    "organizationNumber": "123456789",
    "address": {
      "streetAddress": "Karl Johan 34",
      "streetAddressLine2": "H0405",
      "city": "Oslo",
      "postCode": "0550",
      "country": "Norway"
    },
    "phoneNumber": "62158537",
    "email": "swaggertestcompany@fiken.gmail",
    "creationDate": "2025-01-01",
    "hasApiAccess": true,
    "accountingStartDate": "2025-01-01",
    "vatRegistrationDate": "2025-02-01"
  }
]

Changes

  • dff97b55851eRevision changes
    • 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

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional write-only property items/phoneNumber to the response with the status