List entities

Retrieve a paginated list of entities (administrators, arrangers, trustees, etc.).

GET /entities

List entities

cURL

curl --request GET \
  --url 'https://www.thereviewport.com/api/entities?apiKey='

200

{
  "meta": {
    "page": 123,
    "pageSize": 123,
    "total": 123,
    "totalPages": 123,
    "hasNextPage": true
  },
  "results": [
    {
      "guid": "<string>",
      "name": "<string>",
      "logo": "<string>",
      "type": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "links": {
        "self": "<string>"
      }
    }
  ]
}

Authorizations

ApiKeyQueryApiKeyHeader

apiKey · string · query · required

API key passed as query parameter

Query Parameters

page · integer · default: 1

Page number (1-indexed)

Required range: x >= 1

pageSize · integer · default: 20

Number of items per page

Required range: 1 <= x <= 100

q · string

Search by name

type · enum<string>

Filter by entity type

Available options: administrator, arranger, coArranger, arrangerCounsel, managerCounsel, paymentAgent, trustee, trusteeCounsel

Response

200

application/json

Successful response

meta · object

Show child attributes

results · object[]

Show child attributes