Get a company

GET /companies/{company_id}

Retrieve a specific company linked to the logged user.

Path parameters

  • company_id string Required

    The Company ID given by Fipto.

    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}.

Responses

  • 200

    Company details

    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 object

      Fields required on all objects.

      Hide data attributes Show data attributes 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/{company_id} 
curl \
 -X GET https://api.fipto.app/companies/9de0691c-bc8d-409b-8f40-75d4f45db2f3
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
    }
  }
}