List records that reference a given target

GET

/api/v1/custom-objects/{objectId}/records/reverse-links

curl --request GET \
  --url 'https://api.pitch2sale.com/api/v1/custom-objects/example/records/reverse-links?target_type=example&target_id=example&include_archived=true' \
  --header 'Authorization: Bearer <token>'

Finds records of this object whose reference fields point at target_type/target_id (optionally one field_key). Returns ids only; the count respects the caller’s view scope.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

objectId

required

string

Query Parameters

target_type

required

string

>= 1 characters <= 80 characters

target_id

required

string

/^[0-9a-fA-F]{24}$/

field_key

string

>= 1 characters <= 64 characters

object_definition_id

string

/^[0-9a-fA-F]{24}$/

include_archived

string

Allowed values: true false

page

integer

>= 1 <= 10000

limit

integer

>= 1 <= 100

Responses

200

OK

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

402

Feature not available on the organization plan

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}