Get companies

GET /companies

Retrieve companies linked to the logged user.

Query parameters

  • page_number number

    The page number retrieved in the paginated results. The default value is 1.

  • page_size number

    The number of items to include in each page of the paginated results. The default value is 100.

  • sort string

    The sort field used to filter data.

    Values are created_at or name. Default value is created_at.

Responses

  • 200

    List of all companies

    Hide response attributes Show response attributes object
    • meta object Required
      Hide meta attributes Show meta attributes object
      • request_id string Required

        Unique identifier generated by the server.

        Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

      • query_parameters object

        Information about the parameters in the request. All query string parameters provided (or implicit/with default value) will be returned

    • data array[object]

      Fields required on all objects.

      Hide data attributes Show data attributes array[object]
      • id string Required

        Unique identifier generated by the server.

        Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

      • type string Required

        Default value is company.

      • attributes object Required
        Hide attributes attributes Show attributes attributes object
GET /companies 
curl \
 -X GET https://api.fipto.app/companies
Response examples (200) 
{
  "meta": {
    "request_id": "string",
    "query_parameters": {}
  },
  "data": [
    {
      "id": "string",
      "type": "company",
      "attributes": {
        "name": "Acme inc",
        "asset_primary": "BTC",
        "payout_required_confirmations": 2
      }
    }
  ]
}
Response examples (200) 
{
  "meta": {
    "request_id": "string",
    "query_parameters": {}
  },
  "data": [
    {
      "id": "string",
      "type": "company",
      "attributes": {
        "name": "Acme inc",
        "asset_primary": "BTC",
        "payout_required_confirmations": 2
      }
    }
  ]
}