Skip to main content
GET
/
core
/
{entity}
/
{entityId}
/
metadata
Get metadata
curl --request GET \
  --url https://api.enterprise.sandbox.uphold.com/core/{entity}/{entityId}/metadata \
  --header 'Authorization: Bearer <token>'
{
  "metadata": {
    "externalId": 123
  }
}
Get metadata retrieves the custom metadata associated with a given entity. The response includes an ETag header representing the current version of the metadata. You can use this value with the If-None-Match header in subsequent requests to efficiently check if the metadata has changed—if it hasn’t, the server returns 304 Not Modified without the response body, saving bandwidth.
Returns 404 Not Found if no metadata exists for the entity. Create metadata using the Set metadata endpoint.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Headers

​
If-None-Match
string

Retrieves the entity metadata only if it does not match the given revision.

Pattern: ^(?:W\/)?"([A-Fa-f0-9]{64})"$

Path Parameters

​
entity
enum<string>
required

The type of entity whose metadata is being accessed.

Available options:
accounts,
external-accounts,
files,
transactions,
users
​
entityId
string
required

The unique identifier of the entity whose metadata is being accessed.

Response

Metadata retrieved.

​
metadata
object
required