Contact groups API

List contact groups

GET /contact_group
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:

  • name
  • id

The following scopes are needed:

  • contact_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 82
Content-Type: application/json
[
  {
    "id": 1,
    "name": "Partner"
  },
  {
    "id": 2,
    "name": "Kunden"
  },
  {
    "id": 3,
    "name": "Lieferanten"
  }
]

Search contact groups

POST /contact_group/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "name",
    "value": "Partner"
  }
]
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
  • name
Name Required Type Description
name optional string

The following scopes are needed:

  • contact_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 27
Content-Type: application/json
[
  {
    "id": 1,
    "name": "Partner"
  }
]

Show contact group

GET /contact_group/4
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
Content-Length: 25
Content-Type: application/json
{
  "id": 4,
  "name": "Doctors"
}

Create contact group

POST /contact_group
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Doctors"
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
name required string (120)

The following scopes are needed:

  • general
Status: 201 Created
X-Authenticated-User: apiextract_1
Content-Length: 25
Content-Type: application/json
{
  "id": 4,
  "name": "Doctors"
}

Overwrite contact group

PUT /contact_group/4
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Doctors"
}
Name Required Type Description
callback optional string
Name Required Type Description
name required string (120)

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 25
Content-Type: application/json
{
  "id": 4,
  "name": "Doctors"
}

Edit contact group

POST /contact_group/4
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Dentists"
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
name optional string (120)

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 26
Content-Type: application/json
{
  "id": 4,
  "name": "Dentists"
}