Get Group

GET

1 from mercoa import Mercoa
2 
3 client = Mercoa(
4     token="YOUR_TOKEN",
5 )
6 client.entity_group.get(
7     entity_group_id="entg_a3582b70-fd04-4888-9185-a640ae9048be",
8 )

Play

200Default

1 {
2   "id": "entg_a3582b70-fd04-4888-9185-a640ae9048be",
3   "entities": [
4     {
5       "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
6       "name": "Acme Inc.",
7       "email": "customer@acme.com",
8       "isCustomer": true,
9       "accountType": "business",
10       "profile": {
11         "business": {
12           "legalBusinessName": "Acme Inc.",
13           "taxIDProvided": true,
14           "email": "customer@acme.com",
15           "businessType": "llc",
16           "phone": {
17             "countryCode": "1",
18             "number": "4155551234"
19           },
20           "address": {
21             "addressLine1": "123 Main St",
22             "city": "San Francisco",
23             "stateOrProvince": "CA",
24             "postalCode": "94105",
25             "addressLine2": "Unit 1",
26             "country": "US"
27           },
28           "ownersProvided": true,
29           "taxId": {
30             "ein": {
31               "number": "12-3456789"
32             }
33           }
34         }
35       },
36       "status": "verified",
37       "acceptedTos": true,
38       "isPayor": true,
39       "isPayee": false,
40       "isNetworkPayor": false,
41       "isNetworkPayee": false,
42       "createdAt": "2024-01-01T00:00:00Z",
43       "updatedAt": "2024-01-02T00:00:00Z",
44       "foreignId": "MY-DB-ID-12345"
45     },
46     {
47       "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
48       "name": "Big Box Store",
49       "email": "vendor@bigboxstore.com",
50       "isCustomer": false,
51       "accountType": "business",
52       "profile": {
53         "business": {
54           "legalBusinessName": "Big Box Store",
55           "taxIDProvided": false,
56           "email": "vendor@bigboxstore.com",
57           "businessType": "publicCorporation",
58           "ownersProvided": false
59         }
60       },
61       "status": "unverified",
62       "acceptedTos": false,
63       "isPayor": false,
64       "isPayee": true,
65       "isNetworkPayor": false,
66       "isNetworkPayee": false,
67       "createdAt": "2024-01-01T00:00:00Z",
68       "updatedAt": "2024-01-02T00:00:00Z",
69       "foreignId": "MY-DB-ID-90909"
70     }
71   ],
72   "metadata": {
73     "key1": "value1"
74   },
75   "foreignId": "your-group-id",
76   "name": "AcmeConglomerate",
77   "emailToName": "acmegroup"
78 }

Get an entity group

Path parameters

entityGroupIdstringRequired

Entity Group ID or Entity Group ForeignID

Query parameters

returnEntityMetadatastringOptional

Return simple key/value metadata for the specified keys for the entities in the group. For more complex metadata, use the Metadata API.

Response

This endpoint returns an object.

idstring

entitieslist of objects

metadatamap from strings to strings

foreignIdstringOptional

namestringOptional

emailToNamestringOptional

Get Group

Path parameters

Headers

Query parameters

Response

Errors