Skip to main content
GET
/
entities
/
{id}
Get entity by ID
curl --request GET \
  --url https://api.ledgerbeam.com/v1/entities/{id} \
  --header 'API-KEY: <api-key>'
{
  "id": "6890b942-df95-43f5-8f38-a5dcee46d24a",
  "name": "Apple",
  "type": "merchant",
  "website": "https://www.apple.com",
  "logo": "https://logos.ledgerbeam.com/www.apple.com",
  "description": "Apple is a multinational technology company...",
  "intermediaries": []
}

​
Overview

Retrieve a specific entity by its ID. This endpoint allows you to get detailed information about an entity using its unique identifier.

Authorizations

​
API-KEY
string
header
required

API key for authentication

Path Parameters

​
id
string
required

Entity ID

Response

Entity retrieved successfully

​
id
string

Entity ID

Example:

"6890b942-df95-43f5-8f38-a5dcee46d24a"

​
name
string

Entity name

Example:

"Apple"

​
type
enum<string>

Entity type

Available options:
merchant,
person,
organization
Example:

"merchant"

​
website
string<uri>

Entity website

Example:

"https://www.apple.com"

Entity logo URL

Example:

"https://logos.ledgerbeam.com/www.apple.com"

​
description
string

Entity description

Example:

"Apple is a multinational technology company..."

​
intermediaries
string[]

List of payment processors or intermediaries

Example:
[]