Contact relations API

List contact relations

GET /contact_relation
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • id
  • contact_id
  • contact_sub_id
  • updated_at

The following scopes are needed:

  • contact_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 194
Content-Type: application/json
[
  {
    "id": 1,
    "contact_id": 2,
    "contact_sub_id": 3,
    "description": "",
    "updated_at": "2015-09-18 15:41:12"
  },
  {
    "id": 2,
    "contact_id": 1,
    "contact_sub_id": 3,
    "description": "CFO",
    "updated_at": "2015-09-18 15:41:31"
  }
]

Search contact relations

POST /contact_relation/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "contact_id",
    "value": 2
  }
]
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • contact_id
  • contact_sub_id
  • id
  • updated_at
Name Required Type Description
contact_id optional string
contact_sub_id optional string
updated_at optional string

The following scopes are needed:

  • contact_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 96
Content-Type: application/json
[
  {
    "id": 1,
    "contact_id": 2,
    "contact_sub_id": 3,
    "description": "",
    "updated_at": "2015-09-18 15:41:12"
  }
]

Show contact relation

GET /contact_relation/2
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • contact_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 7a0883bf585a94d60d106b6ce3d8e082
Content-Length: 97
Content-Type: application/json
{
  "id": 2,
  "contact_id": 1,
  "contact_sub_id": 3,
  "description": "CFO",
  "updated_at": "2015-09-18 15:41:31"
}

Create contact relation

POST /contact_relation
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "contact_id": 1,
  "contact_sub_id": 3,
  "description": "CFO"
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
contact_id required Resource contact
contact_sub_id required Resource contact
description optional string

The following scopes are needed:

  • contact_edit
Status: 201 Created
X-Authenticated-User: apiextract_1
Etag: 7a0883bf585a94d60d106b6ce3d8e082
Content-Length: 97
Content-Type: application/json
{
  "id": 2,
  "contact_id": 1,
  "contact_sub_id": 3,
  "description": "CFO",
  "updated_at": "2015-09-18 15:41:31"
}

Overwrite contact relation

PUT /contact_relation/2
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "contact_id": 1,
  "contact_sub_id": 3,
  "description": "CFO"
}
Name Required Type Description
callback optional string
Name Required Type Description
contact_id required Resource contact
contact_sub_id required Resource contact
description optional string

The following scopes are needed:

  • contact_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 7a0883bf585a94d60d106b6ce3d8e082
Content-Length: 97
Content-Type: application/json
{
  "id": 2,
  "contact_id": 1,
  "contact_sub_id": 3,
  "description": "CFO",
  "updated_at": "2015-09-18 15:41:31"
}

Edit contact relation

POST /contact_relation/2
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "contact_id": 1,
  "contact_sub_id": 3,
  "description": "CFO"
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
contact_id optional Resource contact
contact_sub_id optional Resource contact
description optional string

The following scopes are needed:

  • contact_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 7a0883bf585a94d60d106b6ce3d8e082
Content-Length: 97
Content-Type: application/json
{
  "id": 2,
  "contact_id": 1,
  "contact_sub_id": 3,
  "description": "CFO",
  "updated_at": "2015-09-18 15:41:31"
}

Delete contact relation

DELETE /contact_relation/2
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • contact_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 16
Content-Type: application/json
{
  "success": true
}