API documentation

Relationship Type Groups

Overview

A contact can have multiple relationships, like a father, brother or lover. We call this a relationship type. Each relationship type belongs to a category. For instance, father belongs to the family category, lover belongs to the love category, etc...

Relationship type groups are account wide. At the moment, relationship type groups are in read-only mode. You can't create, edit or delete them.

All available relationship type groups

Here are all the default relationship type groups of each account:

Name
love
family
friend
work

List all the relationship type groups in an account

GET /relationshiptypegroups/

Response

{
  "data": [
    {
      "id": 1,
      "object": "relationshiptypegroup",
      "name": "love",
      "delible": false,
      "account": {
        "id": 1
      },
      "created_at": null,
      "updated_at": null
    },
    {
      "id": 2,
      "object": "relationshiptypegroup",
      "name": "family",
      "delible": false,
      "account": {
        "id": 1
      },
      "created_at": null,
      "updated_at": null
    },
    {
      "id": 3,
      "object": "relationshiptypegroup",
      "name": "friend",
      "delible": false,
      "account": {
        "id": 1
      },
      "created_at": null,
      "updated_at": null
    },
    {
      "id": 4,
      "object": "relationshiptypegroup",
      "name": "work",
      "delible": false,
      "account": {
        "id": 1
      },
      "created_at": null,
      "updated_at": null
    }
  ],
  "links": {
    "first": "http:\/\/monica.test\/api\/relationshiptypegroups?page=1",
    "last": "http:\/\/monica.test\/api\/relationshiptypegroups?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "http:\/\/monica.test\/api\/relationshiptypegroups",
    "per_page": 15,
    "to": 4,
    "total": 4
  }
}

Get a specific relationship type group

GET /contactfieldtypes/:id

Response

{
  "data": {
    "id": 1,
    "object": "relationshiptypegroup",
    "name": "love",
    "delible": false,
    "account": {
      "id": 1
    },
    "created_at": null,
    "updated_at": null
  }
}

Company

Resources

© 2018

Proudly Canadian