OrganizationRelationships

Get all relationships for organization

Copy link
Copy to clipboard
GET

/v1/organizationRelationships

Gets all of the relationships for a supplied organization ID.

Query parameters

org_id

integer

required

ID of the organization to get relationships for

Response
200

success

Expand all
Copy code
    • true
    • [ ... ]
      • { ... }
        • { ... }

        Get one organization relationship

        Copy link
        Copy to clipboard
        GET

        /v1/organizationRelationships/{id}

        Finds and returns an organization relationship from its ID.

        Path parameters

        id

        integer

        required

        ID of the organization relationship

        Query parameters

        org_id

        integer

        ID of the base organization for the returned calculated values

        Response
        200

        success

        Expand all
        Copy code
          • true
          • [ ... ]
            • { ... }

            Create an organization relationship

            Copy link
            Copy to clipboard
            POST

            /v1/organizationRelationships

            Creates and returns an organization relationship.

            Body parameters

            application/json

            org_id

            integer

            ID of the base organization for the returned calculated values

            type

            string

            The type of organization relationship

            Values

            parent

            related

            rel_owner_org_id

            integer

            The owner of this relationship. If type is parent, then the owner is the parent and the linked organization is the daughter.

            rel_linked_org_id

            integer

            The linked organization in this relationship. If type is parent, then the linked organization is the daughter.

            Response
            200

            success

            Expand all
            Copy code
              • true
              • [ ... ]
                • { ... }

                Update an organization relationship

                Copy link
                Copy to clipboard
                PUT

                /v1/organizationRelationships/{id}

                Updates and returns an organization relationship.

                Path parameters

                id

                integer

                required

                ID of the organization relationship

                Body parameters

                application/json

                org_id

                integer

                ID of the base organization for the returned calculated values

                type

                string

                The type of organization relationship

                Values

                parent

                related

                rel_owner_org_id

                integer

                The owner of this relationship. If type is parent, then the owner is the parent and the linked organization is the daughter.

                rel_linked_org_id

                integer

                The linked organization in this relationship. If type is parent, then the linked organization is the daughter.

                Response
                200

                success

                Expand all
                Copy code
                  • true
                  • [ ... ]
                    • { ... }

                    Delete an organization relationship

                    Copy link
                    Copy to clipboard
                    DELETE

                    /v1/organizationRelationships/{id}

                    Deletes an organization relationship and returns the deleted id.

                    Path parameters

                    id

                    integer

                    required

                    ID of the organization relationship

                    Response
                    200

                    success

                    Expand all
                    Copy code
                      • true
                      • { ... }

                      Subscribe to Pipedrive’s Developer Newsletter