Skip to navigation

Retrieve the configuration

Returns everything an agent or person configures as one document: credit types, outcome definitions, plans, webhook endpoints, routing rules and notification rules. hash identifies this exact state, so a later PUT /v1/config can say which state it was based on. Needs the config:read scope.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Response

The configuration document and its hash.
object"config"
hashstring

Identifies this exact state. Send it back as if_match.

documentobject

Everything an agent or person configures, in the shape the create requests take. Leave a section out to leave it alone. Objects with a key are matched by key, webhook endpoints by url. Routing rules and notification rules are ordered lists that replace the current ones. Payment providers are connected with POST /v1/payment_providers, because a person completes that step.

livemodeboolean
generated_atdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error