Retrieve a row

GET /v1/tenants/{tenant}/rows/{schema}/{pk}

Open a single record by its keyThis returns one row rather than a filtered list.

Select the tableUse the registered schema ID.
Supply the primary keyLocate the exact record to read.
Read its column valuesKeep a returned version for a later conditional write.

Before you start

Use your database bearer token.

Use an existing table and primary key. Save _oc_row_version if you plan a conditional update.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`schema`	`string`	Required
`pk`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

The body is the row's column values. If a row version is returned, keep it for a conditional write. The lookup uses one primary key; it is not a filtered list query.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
404	Check the resource ID and API route.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/rows/demo.people/u1" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "id": "u1",
  "follows_id": "u2",
  "score": 10
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses