ATatlar
Entities

List entities

Changed on

Returns a list of entities. For further details on Pagination, see general section above.

get/financial-data/v2/entities

Request

Query parameters

limitinteger

Limit the number of items in resulting query response.

tokenstring

If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.

Response

List of entities.

nextTokenstring required

Pagination token for next page. The value will be a non-empty string if there are more resources to be fetched. The value will be an empty string if there are no more resources to be fetched.

tokenstring required

The pagination token that was used for this request. The value will be an empty string if no token query parameter was provided with the request.

limitinteger required

The page limit that was used for this request.

Example response

{
  "items": [
    {
      "id": "ce474c91-c09f-4200-81f8-0be97e1cda47",
      "organizationId": "6ee651dd-8982-4359-a9a7-7cd6bd1d8c41",
      "legalName": "Example Company GmbH",
      "name": "Example Company GmbH",
      "created": "2023-04-14T12:31:12.889104898Z",
      "updated": "2023-04-14T12:31:12.889104898Z",
      "version": 1
    }
  ],
  "nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
  "limit": 100
}

Changes

  • b49df1e4b3e9Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property /// to the response with the status