Skip to main content
GET
/
api
/
v2
/
{object_api_name}
/
{record_id}
/
relationship
/
{api_name}
Paginated single-relationship view for a custom-object record
curl --request GET \
  --url https://api.example.com/api/v2/{object_api_name}/{record_id}/relationship/{api_name} \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next_cursor": "<string>",
  "parent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "record_type": "<string>"
  },
  "api_name": "<string>",
  "items": [
    {
      "related_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "related_record_type": "<string>",
      "through": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "record_type": "<string>",
        "attributes": {}
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Reevo API key passed as Authorization: Bearer <api-key>.

Path Parameters

​
object_api_name
string
required
​
record_id
string<uuid>
required
​
api_name
string
required

Query Parameters

​
cursor
string | null
​
page_size
integer
default:50
Required range: x >= 1

Response

Successful Response

Backward-compatible response name for generic relationship reads.

​
count
integer
required
​
next_cursor
string | null
required
​
parent
ParentRef · object
required

Reference back to the parent record on a sub-resource response.

​
api_name
string
required
​
items
RelationshipItem · object[]
required