Skip to content
SonoraSonora API

Get an enrichment

GET
/enrichment-configs/{configId}
curl --request GET \
  --url https://api.usesonora.com/v1/enrichment-configs/example \
  --header 'Authorization: Bearer <token>'

One enrichment, by the id its values carry as configId.

Requires the customers:read scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
configId
required
string

The enrichment’s id.

Responses

Section titled “Responses”

200

Section titled “200”

The enrichment.

Media typeapplication/json

An enrichment: a field Sonora’s AI fills in on each record, from your calls, emails and tickets.

object
id
required

Stable across edits to the enrichment: the configId its values carry.

string
title
required
string
description
required
string | null
entityType
required

The kind of record it describes. Only customer today.

string
Allowed values: customer
outputType
required

What the value is: short_text/long_text a string, number a number, score 1–10 (10 strongest), boolean, date YYYY-MM-DD, email, url, or select one of options (a list of them with multiple).

string
Allowed values: short_text long_text number score boolean date email url select
options
required
Any of:
Array<string>
multiple
required

select only: whether a value is a list of options.

boolean
createdAt
required
string format: date-time
updatedAt
required

When the enrichment was last edited.

string format: date-time
links
required
object
self
required

This resource’s canonical URL on the API host.

string
Example
{
  "entityType": "customer",
  "outputType": "short_text"
}

Headers

Section titled “Headers”
ETag
string

A fingerprint of the enrichment’s current version. Send it back as If-Match to update only if nobody has edited it since.

401

Section titled “401”

unauthorized: The Authorization header is missing, or the key is invalid, revoked or expired.

Media typeapplication/json

The one error shape every endpoint answers with.

object
error
required
object
code
required

Stable snake_case code to branch on; see the error table.

string
message
required

For humans; may change.

string
details
object
key
additional properties
requestId
required

Quote it when asking for help.

string | null
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {
      "additionalProperty": "example"
    },
    "requestId": "example"
  }
}

403

Section titled “403”

insufficient_scope: The key or token lacks the scope this endpoint needs, and details.required names it; or an OAuth access token called an endpoint only an API key can.

Media typeapplication/json

The one error shape every endpoint answers with.

object
error
required
object
code
required

Stable snake_case code to branch on; see the error table.

string
message
required

For humans; may change.

string
details
object
key
additional properties
requestId
required

Quote it when asking for help.

string | null
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {
      "additionalProperty": "example"
    },
    "requestId": "example"
  }
}

404

Section titled “404”

enrichment_config_not_found: No enrichment with that id, or not one a key can read.

Media typeapplication/json

The one error shape every endpoint answers with.

object
error
required
object
code
required

Stable snake_case code to branch on; see the error table.

string
message
required

For humans; may change.

string
details
object
key
additional properties
requestId
required

Quote it when asking for help.

string | null
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {
      "additionalProperty": "example"
    },
    "requestId": "example"
  }
}

429

Section titled “429”

rate_limited: Too many requests for this key; retry after Retry-After seconds.

Media typeapplication/json

The one error shape every endpoint answers with.

object
error
required
object
code
required

Stable snake_case code to branch on; see the error table.

string
message
required

For humans; may change.

string
details
object
key
additional properties
requestId
required

Quote it when asking for help.

string | null
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {
      "additionalProperty": "example"
    },
    "requestId": "example"
  }
}

500

Section titled “500”

internal_error: Something went wrong on Sonora’s side. Retry, and quote requestId if it persists.

Media typeapplication/json

The one error shape every endpoint answers with.

object
error
required
object
code
required

Stable snake_case code to branch on; see the error table.

string
message
required

For humans; may change.

string
details
object
key
additional properties
requestId
required

Quote it when asking for help.

string | null
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {
      "additionalProperty": "example"
    },
    "requestId": "example"
  }
}

Try it

Run this request against your own Sonora workspace. Sign in, pick the workspace, and the page gets an access token that only reads, only what your role covers, for an hour.

GEThttps://api.usesonora.com/v1/enrichment-configs/{configId}

As curl

$SONORA_TOKEN is your access token or an API key; the page never shows the token.