Search by name

We reserve the right to change this documentation

Verison: 1.0 (read more)

Search by name

1
GET /recipients/?q={searchPhrase}&perPage={limit}

q query param represents query - search phrase we want to search by

perPage sets the limit of returned data, by default 1000 records will be returned if not specified

Response

HTTP/1.1 200 OK

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
[{
    "number": 1,
    "customerNumber": "12",
    "name": "Ole Nordman",
    "contact": {
        "address": {
            "address1": "Oslogata",
            "address2": "",
            "city": "OSLO",
            "country": "NORGE",
            "zip": "0194"
        },
        "email": "ole@sendregning.no",
        "phone": "555555",
        "mobile": "666666",
        "fax": "777777",
        "web": "www.sendregning.no"
    },
    "organisation": {
        "form": "as",
        "icd": "9908",
        "number": "976098897"
    },
    "settings": {
        "discount": 0.0,
        "creditDays": 12,
        "attachPdf": false,
        "defaultShipment": "EMAIL",
        "currency": "EUR",
        "lost": false
    },
    "avtaleGiro": {
      "enabled": true,
      "kid": "000000040000000006"
    },
    "yourReference": "your reference",
    "customFields": null,
    "comment": "some comment",
    "deleted": false,
    "_links": {
        "self": {
          "uri": "/recipients/1"
        },
        "delete": {
          "uri": "/recipients/1"
        }
    }
}]