Get entity details

GET

/v1/entities

GET

/v1/entities

1 from openledger import OpenLedgerClient
2 client = OpenLedgerClient(token="YOUR_TOKEN", )
3 client.entities.get_entity_details()

Try it

200Retrieved

1 {
2   "entity": {
3     "id": "id",
4     "name": "name",
5     "externalId": "externalId",
6     "entityType": "entityType",
7     "address": {
8       "street": "street",
9       "city": "city",
10       "state": "state",
11       "zip": "zip",
12       "country": "country"
13     },
14     "settings": {},
15     "plaidAccounts": [
16       {
17         "id": "id",
18         "plaidAccessToken": "plaidAccessToken",
19         "plaidItemId": "plaidItemId",
20         "plaidInstitutionId": "plaidInstitutionId",
21         "plaidAccountId": "plaidAccountId",
22         "accountName": "accountName",
23         "accountType": "accountType",
24         "accountSubtype": "accountSubtype",
25         "accountMask": "accountMask",
26         "linkedAt": "linkedAt",
27         "status": "status",
28         "entityId": "entityId",
29         "cursor": null,
30         "needsInitialSync": false
31       }
32     ],
33     "createdAt": "createdAt",
34     "developerId": "developerId",
35     "instanceId": "instanceId",
36     "status": "status"
37   }
38 }

Retrieves details for a specific entity

Query parameters

entityIdstringOptional

ID of the entity to retrieve

Response

Entity details retrieved successfully

entityobjectOptional

Get entity details

Headers

Query parameters

Response

Errors