Salutations API

List salutations

GET /salutation
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

The following scopes are needed:

  • contact_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 73
Content-Type: application/json
[
  {
    "id": 1,
    "name": "Herr"
  },
  {
    "id": 2,
    "name": "Frau"
  },
  {
    "id": 3,
    "name": "Familie"
  }
]

Search salutations

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

The following scopes are needed:

  • contact_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 54
Content-Type: application/json
[
  {
    "id": 2,
    "name": "Frau"
  },
  {
    "id": 4,
    "name": "Herr & Frau"
  }
]

Show salutation

GET /salutation/5
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: 21
Content-Type: application/json
{
  "id": 5,
  "name": "Mr."
}

Create salutation

POST /salutation
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Mr."
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
name required string (50)

The following scopes are needed:

  • general
Status: 201 Created
X-Authenticated-User: apiextract_1
Content-Length: 21
Content-Type: application/json
{
  "id": 5,
  "name": "Mr."
}

Overwrite salutation

PUT /salutation/5
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Mr."
}
Name Required Type Description
callback optional string
Name Required Type Description
name required string (50)

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 21
Content-Type: application/json
{
  "id": 5,
  "name": "Mr."
}

Edit salutation

POST /salutation/5
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "Mrs."
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
name optional string (50)

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 22
Content-Type: application/json
{
  "id": 5,
  "name": "Mrs."
}

Delete salutation

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

The following scopes are needed:

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