Find entities

Use case

Here we will find the entities associated with the PERSON group.

Use case data	API parameters with values
The query parameter is the group code (in this case, PERSON).	".../entity?groupCode=PERSON"

Sample API call

To find the entities, use the following endpoint:

https://lookup-api.sandbox.tuumplatform.com/api/v1/entity?groupCode=PERSON

Sample response

Below you will find the response to the sample request:

Response

{
  "errors": null,
  "validationErrors": null,
  "data": [
    "PERSON.ADDRESS",
    "PERSON.DOCUMENT",
    "PERSON.EXTERNAL_CONTRACTS",
    "PERSON.FINANCIAL_DATA",
    "PERSON.PERSON",
    "PERSON.PERSON_RELATIONSHIP"
  ]
}

Result

We can see the list of entity names for the person module. Next, we will find the lookup types associated with the entity PERSON.ADDRESS.

You cannot edit the entities that are available in the system.