---
title: Get list of entities
slug: oip-webservice/get-list-of-entities
createdAt: 2025-06-27T15:20:49.046Z
---

{
  "id": "iTqt_RmuZRrGURhsC3GDb",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://oip-api-dev.fasst.tech/api/core/entities/{version}",
    "name": "Get list of entities",
    "description": "Get list of entities from OIP CORE",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "version",
          "type": "string",
          "description": "1.0.0"
        }
      ],
      "headerParameters": [
        {
          "kind": "required",
          "name": "Authorization",
          "type": "string",
          "description": "<p>Bearer 9109331d-6c43-4d4d-aae7-888bdd446800</p>"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "array",
            "description": "",
            "customType": "responses.EntityResponse[]",
            "schema": [
              {
                "name": "coreVersion",
                "kind": "optional",
                "type": "string",
                "example": "1.0.0"
              },
              {
                "name": "description",
                "kind": "optional",
                "type": "string",
                "example": "Structure du projet"
              },
              {
                "name": "isArray",
                "kind": "optional",
                "type": "boolean",
                "example": true
              },
              {
                "name": "isDeprecated",
                "kind": "optional",
                "type": "boolean",
                "example": true
              },
              {
                "name": "methods",
                "kind": "optional",
                "type": "array",
                "example": "[\"get\",\"findAll\"]",
                "itemType": "string",
                "customType": "string[]",
                "itemExample": "",
                "itemDefault": ""
              },
              {
                "name": "name",
                "kind": "optional",
                "type": "string",
                "example": "Project"
              },
              {
                "name": "properties",
                "kind": "optional",
                "type": "array",
                "description": "",
                "modelRef": "#/definitions/responses.PropertyResponse",
                "customType": "responses.PropertyResponse[]",
                "schema": [
                  {
                    "name": "deprecatedMessage",
                    "kind": "optional",
                    "type": "string",
                    "example": "message"
                  },
                  {
                    "name": "description",
                    "kind": "optional",
                    "type": "string",
                    "example": "description"
                  },
                  {
                    "name": "isDeprecated",
                    "kind": "optional",
                    "type": "boolean",
                    "example": false
                  },
                  {
                    "name": "isReadonly",
                    "kind": "optional",
                    "type": "boolean",
                    "example": false
                  },
                  {
                    "name": "name",
                    "kind": "optional",
                    "type": "string",
                    "example": "name"
                  },
                  {
                    "name": "type",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "modelRef": "#/definitions/responses.TypeResponse",
                    "customType": "responses.TypeResponse",
                    "schema": [
                      {
                        "name": "enumValues",
                        "kind": "optional",
                        "type": "array",
                        "example": "[\"enum1\",\" enum2\"]",
                        "itemType": "string",
                        "customType": "string[]",
                        "itemExample": "",
                        "itemDefault": ""
                      },
                      {
                        "name": "isArray",
                        "kind": "required",
                        "type": "boolean",
                        "example": false
                      },
                      {
                        "name": "name",
                        "kind": "required",
                        "type": "string",
                        "example": "name"
                      }
                    ]
                  },
                  {
                    "name": "validator",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "modelRef": "#/definitions/responses.ValidatorResponse",
                    "customType": "responses.ValidatorResponse",
                    "schema": [
                      {
                        "name": "exactLength",
                        "kind": "required",
                        "type": "integer",
                        "example": 4
                      },
                      {
                        "name": "maxLength",
                        "kind": "required",
                        "type": "integer",
                        "example": 4
                      },
                      {
                        "name": "minLength",
                        "kind": "required",
                        "type": "integer",
                        "example": 4
                      },
                      {
                        "name": "type",
                        "kind": "required",
                        "type": "array",
                        "example": "[\"mail\",\" postal\"]",
                        "itemType": "string",
                        "customType": "string[]",
                        "itemExample": "",
                        "itemDefault": ""
                      }
                    ]
                  }
                ]
              },
              {
                "name": "relations",
                "kind": "optional",
                "type": "array",
                "description": "",
                "modelRef": "#/definitions/responses.RelationResponse",
                "customType": "responses.RelationResponse[]",
                "schema": [
                  {
                    "name": "isArray",
                    "kind": "required",
                    "type": "boolean",
                    "example": ""
                  },
                  {
                    "name": "propertyName",
                    "kind": "required",
                    "type": "string",
                    "example": "name"
                  },
                  {
                    "name": "propertyType",
                    "kind": "required",
                    "type": "string",
                    "example": "string"
                  }
                ]
              }
            ],
            "modelRef": "#/definitions/responses.EntityResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://oip-api-dev.fasst.tech/api/core/entities/{version} \\\n     --header 'accept: application/json' \\\n     --header 'authorization: string'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"authorization\", \"string\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://oip-api-dev.fasst.tech/api/core/entities/{version}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://oip-api-dev.fasst.tech/api/core/entities/{version}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"authorization\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://oip-api-dev.fasst.tech/api/core/entities/{version}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json',\n   'authorization': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// OK\n[\n  {\n    \"coreVersion\": \"1.0.0\",\n    \"description\": \"Structure du projet\",\n    \"isArray\": true,\n    \"isDeprecated\": true,\n    \"methods\": [\n      \"\"\n    ],\n    \"name\": \"Project\",\n    \"properties\": [\n      {\n        \"deprecatedMessage\": \"message\",\n        \"description\": \"description\",\n        \"isDeprecated\": false,\n        \"isReadonly\": false,\n        \"name\": \"name\",\n        \"type\": {\n          \"enumValues\": [\n            \"\"\n          ],\n          \"isArray\": false,\n          \"name\": \"name\"\n        },\n        \"validator\": {\n          \"exactLength\": 4,\n          \"maxLength\": 4,\n          \"minLength\": 4,\n          \"type\": [\n            \"\"\n          ]\n        }\n      }\n    ],\n    \"relations\": [\n      {\n        \"isArray\": false,\n        \"propertyName\": \"name\",\n        \"propertyType\": \"string\"\n      }\n    ]\n  }\n]"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}