Relationships

Gets a list of Relationships

This read only endpoint returns a list of the relationships that have been defined for the Insightly instance. Relationships enable users to define how one Insightly object is related to another. For example: contact A is a customer of contact B. The API only supports read access to relationships, to create or update relationships, you'll need to do so via the web app.

get/Relationships

Request

  • Base URL
    https://api.insightly.com/v3.1
  • Auth
    none declared. Required headers: Authorization

Query parameters

skipinteger

Optional, number of records to skip.

topinteger

Optional, maximum number of records to return in the response.

count_totalboolean

Optional, true if total number of records should be returned in the response headers.

Headers

Authorizationstring required

Authorization

Response

Request succeeded.

RELATIONSHIP_IDinteger
FORWARD_TITLEstring
FORWARDstring
REVERSE_TITLEstring
REVERSEstring
FOR_CONTACTSboolean
FOR_ORGANISATIONSboolean

Changes

No recorded changes to this operation across all 1 revision of this API.