People management
      Back to home
      1. Knowledge base
      2. Gamfi API Docs
      3. People management

      Getting list of companies

      In this article, you will discover how to download a list of companies in the Gamfi application using the API.

      To download the list of companies from the Gamfi application use the method and endpoint:

      GET + /api/app_api_admin.php/v2/workflows/integration/companies

      Example cURL:

      curl --location 'https://{app_name}.gamfi.io/api/app_api_admin.php/v2/workflows/integration/companies' \
      --header 'X-Samus-Authorization-Api-Key: {apiKey}' \
      --header 'X-Samus-Authorization-Api-Secret: {apiSecret}' \
      --header 'Content-Type: application/json'

      In place:

      • {app_name} - insert the name of your application
      • {apiKey} - insert API key
      • {apiSecret} - insert API secret

      If the response is correct (200), you will receive a confirmation:

      {
          "items": [
              {
                  "id": "e0759f9b-1686-4040-a9f7-ddbbb82e0e0c",
                  "name": "Company #1",
                  "description": ""
              },
              {
                  "id": "714f3759-d2a4-4ccb-ae6e-ae05e9b2c515",
                  "name": "Company #2",
                  "description": ""
              },
              {
                  "id": "f99de80f-87d7-403b-acd3-0db62a88d4d5",
                  "name": "Company #3",
                  "description": ""
              }
          ],
          "count": 3
      }