This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /partners/{partnerId}/contacts
Get list of contacts related to partner
Description
Returns list of contacts
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| partnerId | required | Id of partner. |
Parameters (query)
| Name | Required | Description | Values |
|---|---|---|---|
| keyword[ct] | optional | Search contacts by keyword. Allowed expression(s): eq, ct | |
| include | optional | The resources that can be included in this request, delimited by a comma: partner, location, email_document_types |
Responses
200
successful operation
Response content JSON schema
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
{
"properties": {
"data": {
"type": "array",
"items": {
"required": [
"name"
],
"properties": {
"id": {
"description": "Id of the contact",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"blocked": {
"description": "If this partner contact is blocked.",
"type": "boolean",
"format": "boolean",
"readOnly": true,
"example": true
},
"cell": {
"description": "Cellphone number of the contact",
"type": "string",
"format": "string",
"example": "+45 00 00 00 00"
},
"comment": {
"description": "A comment related to the contact",
"type": "string",
"format": "string",
"example": "Don't call at night"
},
"email": {
"description": "A valid e-mail address",
"type": "string",
"format": "email",
"example": "test@test.test"
},
"is_default": {
"description": "If this is the default contact that should be chosen on orders when the parent partner is selected",
"type": "boolean",
"format": "boolean",
"example": true
},
"location_id": {
"description": "If this contact is related to a specific location of the partner, the location id can be specified here.",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"locked": {
"description": "If this partner contact is locked. Usually because other entities reference the contact. When the contact is locked it cannot be deleted.",
"type": "boolean",
"format": "boolean",
"readOnly": true,
"example": true
},
"name": {
"description": "Name of the contact",
"type": "string",
"format": "string",
"example": "John Johnsson"
},
"partner_id": {
"description": "Reference to the partner model",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"phone": {
"description": "Phone number of the contact",
"type": "string",
"format": "string",
"example": "+45 00 00 00 00"
},
"ref": {
"description": "A reference code for this contact that can be used to identify the contact accross applications.",
"type": "string",
"format": "string",
"example": "9FA"
},
"title": {
"description": "Title of the contact. Eg. CEO, Warehouse Manager",
"type": "string",
"format": "string",
"example": "Warehouse Manager"
},
"email_document_types": {
"description": "Document types to email. \nThe document types where this contact should be put as a default recipient.\nNotice that *email_document_types* should be included in the include parameter to be loaded",
"type": "array",
"items": {
"format": "string",
"example": "DeliveryDeliveryNote"
},
"enum": [
"DeliveryDeliveryNote",
"DeliveryPickingList",
"DeliveryReleaseNote",
"DeliveryTransportBookingOrdinary",
"DeliveryTransportBookingRefrigerated",
"OrderPurchaseQuote",
"OrderPurchaseOrder",
"OrderSalesQuote",
"OrderSalesOrder",
"OrderReturnOrder",
"OrderWarehouseOrder",
"OrderProductionOrder",
"Invoice",
"InvoiceProforma",
"CreditNote"
]
},
"created_at": {
"description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2019-01-01T13:25:32.312Z"
},
"updated_at": {
"description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
}
},
"meta": {
"description": "Meta with pagination",
"properties": {
"current_page": {
"description": "The current page",
"type": "integer"
},
"from": {
"description": "The starting position of the current page results",
"type": "integer"
},
"last_page": {
"description": "The last page",
"type": "integer"
},
"path": {
"description": "The current path of the request",
"type": "string"
},
"per_page": {
"description": "Records that are displayed pr request",
"type": "integer"
},
"to": {
"description": "The ending position of the current page results",
"type": "integer"
},
"total": {
"description": "Number of records that are matched by the current query",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
}
403
Unauthorized request
406
not acceptable
500
internal server error
POST /partners/{partnerId}/contacts
Create new contact
Description
Create a new contact
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| partnerId | required | Id of partner. |
Request body
Description
Target contact.
Required
This parameter is required.
Request body JSON schema
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
{
"required": [
"name"
],
"properties": {
"id": {
"description": "Id of the contact",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"blocked": {
"description": "If this partner contact is blocked.",
"type": "boolean",
"format": "boolean",
"readOnly": true,
"example": true
},
"cell": {
"description": "Cellphone number of the contact",
"type": "string",
"format": "string",
"example": "+45 00 00 00 00"
},
"comment": {
"description": "A comment related to the contact",
"type": "string",
"format": "string",
"example": "Don't call at night"
},
"email": {
"description": "A valid e-mail address",
"type": "string",
"format": "email",
"example": "test@test.test"
},
"is_default": {
"description": "If this is the default contact that should be chosen on orders when the parent partner is selected",
"type": "boolean",
"format": "boolean",
"example": true
},
"location_id": {
"description": "If this contact is related to a specific location of the partner, the location id can be specified here.",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"locked": {
"description": "If this partner contact is locked. Usually because other entities reference the contact. When the contact is locked it cannot be deleted.",
"type": "boolean",
"format": "boolean",
"readOnly": true,
"example": true
},
"name": {
"description": "Name of the contact",
"type": "string",
"format": "string",
"example": "John Johnsson"
},
"partner_id": {
"description": "Reference to the partner model",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"phone": {
"description": "Phone number of the contact",
"type": "string",
"format": "string",
"example": "+45 00 00 00 00"
},
"ref": {
"description": "A reference code for this contact that can be used to identify the contact accross applications.",
"type": "string",
"format": "string",
"example": "9FA"
},
"title": {
"description": "Title of the contact. Eg. CEO, Warehouse Manager",
"type": "string",
"format": "string",
"example": "Warehouse Manager"
},
"email_document_types": {
"description": "Document types to email. \nThe document types where this contact should be put as a default recipient.\nNotice that *email_document_types* should be included in the include parameter to be loaded",
"type": "array",
"items": {
"format": "string",
"example": "DeliveryDeliveryNote"
},
"enum": [
"DeliveryDeliveryNote",
"DeliveryPickingList",
"DeliveryReleaseNote",
"DeliveryTransportBookingOrdinary",
"DeliveryTransportBookingRefrigerated",
"OrderPurchaseQuote",
"OrderPurchaseOrder",
"OrderSalesQuote",
"OrderSalesOrder",
"OrderReturnOrder",
"OrderWarehouseOrder",
"OrderProductionOrder",
"Invoice",
"InvoiceProforma",
"CreditNote"
]
},
"created_at": {
"description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2019-01-01T13:25:32.312Z"
},
"updated_at": {
"description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
}
Responses
201
successful operation
Response content JSON schema
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
{
"properties": {
"required": [
"name"
],
"properties": {
"id": {
"description": "Id of the contact",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"blocked": {
"description": "If this partner contact is blocked.",
"type": "boolean",
"format": "boolean",
"readOnly": true,
"example": true
},
"cell": {
"description": "Cellphone number of the contact",
"type": "string",
"format": "string",
"example": "+45 00 00 00 00"
},
"comment": {
"description": "A comment related to the contact",
"type": "string",
"format": "string",
"example": "Don't call at night"
},
"email": {
"description": "A valid e-mail address",
"type": "string",
"format": "email",
"example": "test@test.test"
},
"is_default": {
"description": "If this is the default contact that should be chosen on orders when the parent partner is selected",
"type": "boolean",
"format": "boolean",
"example": true
},
"location_id": {
"description": "If this contact is related to a specific location of the partner, the location id can be specified here.",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"locked": {
"description": "If this partner contact is locked. Usually because other entities reference the contact. When the contact is locked it cannot be deleted.",
"type": "boolean",
"format": "boolean",
"readOnly": true,
"example": true
},
"name": {
"description": "Name of the contact",
"type": "string",
"format": "string",
"example": "John Johnsson"
},
"partner_id": {
"description": "Reference to the partner model",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"phone": {
"description": "Phone number of the contact",
"type": "string",
"format": "string",
"example": "+45 00 00 00 00"
},
"ref": {
"description": "A reference code for this contact that can be used to identify the contact accross applications.",
"type": "string",
"format": "string",
"example": "9FA"
},
"title": {
"description": "Title of the contact. Eg. CEO, Warehouse Manager",
"type": "string",
"format": "string",
"example": "Warehouse Manager"
},
"email_document_types": {
"description": "Document types to email. \nThe document types where this contact should be put as a default recipient.\nNotice that *email_document_types* should be included in the include parameter to be loaded",
"type": "array",
"items": {
"format": "string",
"example": "DeliveryDeliveryNote"
},
"enum": [
"DeliveryDeliveryNote",
"DeliveryPickingList",
"DeliveryReleaseNote",
"DeliveryTransportBookingOrdinary",
"DeliveryTransportBookingRefrigerated",
"OrderPurchaseQuote",
"OrderPurchaseOrder",
"OrderSalesQuote",
"OrderSalesOrder",
"OrderReturnOrder",
"OrderWarehouseOrder",
"OrderProductionOrder",
"Invoice",
"InvoiceProforma",
"CreditNote"
]
},
"created_at": {
"description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2019-01-01T13:25:32.312Z"
},
"updated_at": {
"description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
"type": "string",
"format": "date-time",
"example": "2020-01-01T13:25:32.312Z"
}
},
"type": "object"
},
"type": "object"
}
403
Unauthorized request
406
not acceptable
422
Has validation errors
500
internal server error