Relationship Type Search

post

https://api.marketcircle.net/v1/relationship_types/_search

Search for relationship types

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

See the search filtering documentation for details about the query syntax. The searchable attributes and the operators each one accepts are listed in the request body below.

{ "for_company": { "equal": true }, "forward": { "contains": "parent" } }

Query Params

limit

int32

≤ 250

Defaults to 50

Maximum number of results per page (max 250). Defaults to 50, or 10 when full-records is true.

full-records

boolean

Return every attribute of each result instead of the short list form.

start

int32

Return results whose ID is greater than or equal to this value. Use the next URL from the previous page rather than building this yourself.

Body Params

forward

object

Example: is the parent company of

reverse

object

Example: is the subsidiary of

forward_title

object

Example: Parent Company

reverse_title

object

Example: Subsidiary

is_active

object

Example: true

for_contact

object

Whether the type can be used between contacts

for_company

object

Whether the type can be used between companies

Responses

200200 OK

400400 Bad Request