<a href="https://www.openledger.com/contact" target="_blank">We are iterating quickly on our docs, please reach out if you need latest and greatest! 🔥🚀</a>
Get a demoPostman Collection
GuideReact SDKAPI Reference
GuideReact SDKAPI Reference
  • API Overview
    • Reference
    • Authentication
    • Rate Limits
    • Pagination
We are iterating quickly on our docs, please reach out if you need latest and greatest! 🔥🚀
LogoLogo
Get a demoPostman Collection
API OverviewAPI EndpointsEntities

Get entity details

GET
/v1/entities
GET
/v1/entities
1curl https://api-staging.openledger.com/v1/entities \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1{
2  "entity": {
3    "id": "string",
4    "name": "string",
5    "externalId": "string",
6    "entityType": "string",
7    "address": {
8      "street": "string",
9      "city": "string",
10      "state": "string",
11      "zip": "string",
12      "country": "string"
13    },
14    "settings": {},
15    "plaidAccounts": [
16      {
17        "id": "string",
18        "plaidAccessToken": "string",
19        "plaidItemId": "string",
20        "plaidInstitutionId": "string",
21        "plaidAccountId": "string",
22        "accountName": "string",
23        "accountType": "string",
24        "accountSubtype": "string",
25        "accountMask": "string",
26        "linkedAt": "2024-01-15T09:30:00Z",
27        "status": "string",
28        "entityId": "string",
29        "cursor": "string",
30        "needsInitialSync": true
31      }
32    ],
33    "createdAt": "2024-01-15T09:30:00Z",
34    "developerId": "string",
35    "instanceId": "string",
36    "status": "string"
37  }
38}
Retrieves details for a specific entity
Was this page helpful?
Previous

Create a new entity

Next
Built with
Create a new entity
Retrieves details for a specific entity

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringOptional
ID of the entity to retrieve

Response

Entity details retrieved successfully
entityobject or null

Errors