Skip to main content
POST
/
tenant
/
list-external-ids
List External Ids
curl --request POST \
  --url https://api.decodahealth.com/tenant/list-external-ids \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "tableName": "<string>",
  "externalIds": [
    "<string>"
  ]
}
'
{
  "tableName": "<string>",
  "externalIdToId": {},
  "foundCount": 123,
  "requestedCount": 123
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

List records by external IDs and return mapping to internal IDs.

tableName
string
required
externalIds
string[]
required

Response

Successful Response

Response for listing external IDs.

tableName
string
required
externalIdToId
Externalidtoid · object
required
foundCount
integer
required
requestedCount
integer
required