Get a counterpart

GET

/counterparts/:counterpart_id

Path parameters

counterpart_idstringRequired

Headers

Auth

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Response

Successful Response

Counterpart Individual Root Responseobject or null

Counterpart Organization Root Responseobject or null

Errors

GET

1 curl https://api.sandbox.monite.com/v1/counterparts/counterpart_id \
2      -H "x-monite-version: 2024-05-25" \
3      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "id": "id",
3   "created_at": "2024-01-15T09:30:00Z",
4   "updated_at": "2024-01-15T09:30:00Z",
5   "created_automatically": true,
6   "default_billing_address_id": "default_billing_address_id",
7   "default_shipping_address_id": "default_shipping_address_id",
8   "created_by_entity_user_id": "created_by_entity_user_id",
9   "individual": {
10     "email": "asingh@example.net",
11     "first_name": "Adnan",
12     "is_customer": true,
13     "is_vendor": true,
14     "last_name": "Singh",
15     "phone": "5553211234",
16     "tags": [
17       {
18         "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
19         "created_at": "2022-09-07T16:35:18Z",
20         "updated_at": "2022-09-07T16:35:18Z",
21         "category": "document_type",
22         "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
23         "description": "Tag for the Marketing Department",
24         "name": "Marketing"
25       }
26     ],
27     "title": "Mr."
28   },
29   "language": "ab",
30   "reminders_enabled": true,
31   "tax_id": "tax_id",
32   "type": "individual"
33 }

Delete a counterpart

Up Next

1	curl https://api.sandbox.monite.com/v1/counterparts/counterpart_id \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>"

1	{
2	"id": "id",
3	"created_at": "2024-01-15T09:30:00Z",
4	"updated_at": "2024-01-15T09:30:00Z",
5	"created_automatically": true,
6	"default_billing_address_id": "default_billing_address_id",
7	"default_shipping_address_id": "default_shipping_address_id",
8	"created_by_entity_user_id": "created_by_entity_user_id",
9	"individual": {
10	"email": "asingh@example.net",
11	"first_name": "Adnan",
12	"is_customer": true,
13	"is_vendor": true,
14	"last_name": "Singh",
15	"phone": "5553211234",
16	"tags": [
17	{
18	"id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
19	"created_at": "2022-09-07T16:35:18Z",
20	"updated_at": "2022-09-07T16:35:18Z",
21	"category": "document_type",
22	"created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
23	"description": "Tag for the Marketing Department",
24	"name": "Marketing"
25	}
26	],
27	"title": "Mr."
28	},
29	"language": "ab",
30	"reminders_enabled": true,
31	"tax_id": "tax_id",
32	"type": "individual"
33	}