Universes Management

Get Universe Entities

ListExport

Get entities for one universe

GET
https://api.textreveal.com/v3/universes/{universe_id}/entities

Request

Parameters

  • universe_id*uuid

    Unique identifier of the universe.

    Example: "75ebc096-749e-4b8f-b690-df13daf49c62"
  • sizeinteger

    Number of records per page

    Default: 10Range: [1, 1000]
  • search_afterstring

    search_after field value from the previous page

  • name(string (operator))[]

    Name of the entity.

    Example: "eq:fujitsu"
  • alias(string (operator))[]

    Alternative name, abbreviation, or local brand used to refer to a company or entity.

    Example: "ilike:fujitsu"
  • duns(string (operator))[]

    Duns number of the entity.

    Example: "eq:000000000"
  • figi(string (operator))[]

    FIGI (Financial Instrument Global Identifier) of the entity.

    Example: "eq:BBG000BGJWM6"
  • isin(string (operator))[]
    Example: "eq:JP3818000006"
  • ticker(string (operator))[]

    Stock market ticker symbol used to identify a publicly traded company on an exchange.

    Example: "eq:6702.T"
  • lei(string (operator))[]

    Legal Entity Identifier (LEI) is a 20-character alphanumeric code.

    Example: "eq:123400ABCDEFGH56789"
  • entity_id(string (operator))[]

    SESAMm Unique Entity ID.

    Example: "eq:7457a013-9c65-451f-b82d-96d7a22b5cfa"
  • website(string (operator))[]

    Website of the entity. Protocol is not always present.

    Example: "eq:https://www.official-website.com"
  • city(string (operator))[]

    Name of the city, town, township, village, borough, etc. where the entity is located. Value is in lowercase.

    Example: "eq:miami"
  • country(string (enum))[]

    Country of the entity.

    Example: "united states of america"
  • registration_code(string (operator))[]

    undefined Searches on the value field.

    Example: "eq:17133723"
  • employee_count(integer (operator))[]

    Number of employees of this company.

    Example: "gte:1000"
  • revenue(integer (operator))[]

    Revenue history of this company. Searches on the value field.

    Example: "gte:1000000"
  • isic4(string (operator))[]
    Example: "eq:Public order and safety activities"
  • sector(string (operator))[]

    ISIC4 section code, a single letter from A to U, as returned by the /isic route.

    You can input a section code or use the following operators: eq (=), neq (≠), in, nin (not in)

    Example: eq:C for Manufacturing, in:C;J to filter on several sections

    Example: "eq:hello"
  • industry_code(string (operator))[]

    undefined Searches on code and description values.

    Example: "eq:1811"
  • unspsc(string (operator))[]

    undefined Searches on code and description values.

    Example: "eq:51000000"
  • region(string (operator))[]

    Administrative region or state in which the entity is located. Value is in lowercase.

    Example: "eq:florida"
  • client_code(string (operator))[]

    Custom entity identifiers to make it easier to link SESAMm entities with external Knowledge Graphs / client systems. The client code are isolated between the SESAMm company model and are not visible to other client.

    To add yours to the entities of your universe, contact your account manager.

    Example: "eq:F32001976"
  • order(field:direction (enum))[]

    Order to apply to the result.

    Possible fields are: name.

    Possible directions are: asc and desc.

    Default: [name:asc]Example: "name:asc"
  • fields(string (enum))[]

    Fields to include in the response

    Default: ["id", "description", "name", "figi", "isin", "ticker", "alias", "website", "country", "employee_count", "revenue", "isic4", "industry_codes", "unspsc", "city", "region", "lei", "client_code", "registration_codes", "created_at"]Values: "id", "description", "name", "figi", "isin", "ticker", "alias", "website", "country", "employee_count", "revenue", "isic4", "industry_codes", "unspsc", "city", "region", "lei", "client_code", "registration_codes", "created_at", "rel... 

Response

Response - 200

Properties of the entities

  • data*object[]

    Properties of the entities.

  • size*integer

    Number of records per page requested.

    Minimum: 1
  • has_next*boolean

    True if there are more records available.

    Example: true
  • count*integer

    Number of records returned in the current page.

    Minimum: 0
  • total*integer

    Total number of records.

    Minimum: 0
  • search_afterstring | null

    Cursor for next page.

Response
{
  "data": [
    {
      "id": "753c48d6-23c8-5fb0-9230-b099898452b5",
      "description": "Fujitsu is a information & communications technology equipment and services firm providing IT & IT infrastructure and other services.",
      "name": "Fujitsu",
      "figi": "BBG000BLNXT1",
      "isin": [
        "US0378331005"
      ],
      "ticker": [
        "AAPL"
      ],
      "alias": [
        "Apple Inc."
      ],
      "website": "https://www.fujitsu.com/",
      "country": "united states of america",
      "employee_count": 16,
      "revenue": [
        {
          "value": 416161000000,
          "currency": "USD",
          "date": "2024-01-01"
        }
      ],
      "isic4": [
        {
          "code": "C",
          "description": "Manufacturing",
          "values": [
            {
              "code": "28",
              "description": "Manufacture of machinery and equipment n.e.c.",
              "values": [
                {
                  "code": "281",
                  "description": "Manufacture of general-purpose machinery",
                  "values": [
                    {
                      "code": "2816",
                      "description": "Manufacture of lifting and handling equipment",
                      "priority": 1
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "industry_codes": [
        {
          "description": "ISIC Revision 4",
          "values": [
            {
              "code": "2816",
              "description": "Manufacture of lifting and handling equipment",
              "priority": 1
            }
          ]
        }
      ],
      "unspsc": [
        {
          "code": "51000000",
          "description": "Drugs and Pharmaceutical Products",
          "priority": 1
        }
      ],
      "city": "miami",
      "region": "florida",
      "lei": "123400ABCDEFGH56789",
      "client_code": {
        "code1": "ABC123456",
        "code2": "789XYZ"
      },
      "registration_codes": [
        {
          "value": "17133723",
          "description": "Trade Register Number (NL)"
        }
      ],
      "created_at": "2024-01-08T10:00:00.000Z",
      "related_universe_count": 0
    }
  ],
  "size": 1,
  "has_next": true,
  "count": 1,
  "total": 1,
  "search_after": "string"
}

Error

Error - 400

Bad request

  • message*string

    Error message.

    Example: "Check the errors field for more details"
  • code*number (enum)

    Error code.

    Values: 400
  • reason*string (enum)

    Error reason.

    Values: "invalid"
  • errorsobject[]

    Possible error causes.

Response
{
  "message": "Check the errors field for more details",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "string",
      "field": "size",
      "reason": "invalid_type"
    }
  ]
}

Error - 404

Not found

  • message*string

    Error message.

    Example: "The requested universe does not exist or is not visible to your company."
  • code*number (enum)

    Error code.

    Values: 404
  • reason*string (enum)

    Error reason.

    Values: "not_found"
Response
{
  "message": "The requested universe does not exist or is not visible to your company.",
  "code": 404,
  "reason": "not_found"
}

Generic errors are not shown, see Errors for more details.