Renidlyrenidly
Getting Started

Quickstart

3 min read

Set up your first Renidly request in under five minutes. No SDK required — every endpoint is a plain HTTPS call you can fire from anything that speaks fetch.

Before you begin

  1. Create an account. Sign up at renidly.com/signup if you don't already have one.
  2. Get your API key. Open Workspace → API Keys, copy your key, and store it somewhere safe.
  3. Pick something to look up. A handle, a stable ID, an organization slug — or just use the sample identifier in the snippets below.
1Make your first request

Send a real request

Requests go to https://renidly.com over HTTPS, authenticated with the X-renidly-apikey header. The example below looks a person up by their public handle:

curl "https://renidly.com/api/data/v1/people/profile?handle=ryanroslansky" \
  -H "X-renidly-apikey: $RENIDLY_API_KEY"
2Read the response

Every response looks the same

Every Renidly endpoint returns the same JSON envelope. Two fields matter for almost every integration: success tells you whether the call worked, and data holds the payload.

{
  "success": true,
  "statusCode": 200,
  "message": "Profile retrieved successfully",
  "errors": null,
  "data": {
    "id": "prsn_06d0d44dogo2m",
    "handle": "ryanroslansky"
    /* …the rest of the record */
  }
}

The full envelope contract — what each field means, when errorsis populated, and the identifiers you'll see in data — is documented in Response Envelope.

3Handle errors predictably

Failed validation is free

If the request is malformed — a missing required parameter, a wrong type, an unknown identifier — the body comes back with success: false and the reason in message. No credits are deducted on failures. See Errors & Retries for the two failure shapes and retry strategy.

Next steps