Skip to main content
GET
Get an entity

Authorizations

api-key
string
header
required

Path Parameters

entityId
string
required

An entity id (ent_) or the sentinel me (the partner's sole entity).

Response

The entity.

id
string
required

Opaque entity id (ent_)

type
enum<string>
required
Available options:
business
externalId
string
metadata
object

Free-form string key/value pairs stored and returned verbatim, never interpreted by Melio. Up to 500 keys; each key 1 to 40 chars and may not contain square brackets ([ ], reserved for the metadata[key] filter); value ≤100 chars. The whole object must serialize to at most 128KB of JSON. Filterable via metadata[key].

createdAt
string<date-time>
updatedAt
string<date-time>
name
string
businessType
string
taxInfo
object
phoneNumber
string
contact
object

Contact as returned in responses; fields may be absent when the stored record is incomplete.

website
string
description
string
address
object

Address as returned in responses; fields may be absent when the stored record is incomplete.

Address as returned in responses; fields may be absent when the stored record is incomplete.

industry
object
owner
object
termsAcceptance
object

The terms of service acceptance on file for this business. Absent when none has been recorded.