Get All | Mercoa | Documentation

from mercoa import Mercoa
client = Mercoa(
    token="YOUR_TOKEN",
)
client.entity.representative.get_all(
    entity_id="ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
)

[
  {
    "id": "rep_958c4ffb-dc06-494c-a0e0-1b4946c6bb0f",
    "name": {
      "firstName": "Jane",
      "lastName": "Smith"
    },
    "address": {
      "addressLine1": "456 Main St",
      "city": "New York",
      "stateOrProvince": "NY",
      "postalCode": "10001",
      "country": "US"
    },
    "birthDateProvided": true,
    "governmentIDProvided": true,
    "responsibilities": {
      "isOwner": true,
      "ownershipPercentage": 40
    },
    "createdOn": "2024-01-01T00:00:00Z",
    "updatedOn": "2024-01-01T00:00:00Z",
    "phone": {
      "countryCode": "1",
      "number": "2075551234"
    },
    "email": "jane.smith@acme.com"
  },
  {
    "id": "rep_7df2974a-4069-454c-912f-7e58ebe030fb",
    "name": {
      "firstName": "John",
      "lastName": "Adams",
      "middleName": "Quincy",
      "suffix": "Jr."
    },
    "address": {
      "addressLine1": "123 Main St",
      "city": "San Francisco",
      "stateOrProvince": "CA",
      "postalCode": "94105",
      "addressLine2": "Unit 1",
      "country": "US"
    },
    "birthDateProvided": true,
    "governmentIDProvided": true,
    "responsibilities": {
      "isController": true,
      "isOwner": true,
      "ownershipPercentage": 40
    },
    "createdOn": "2024-01-01T00:00:00Z",
    "updatedOn": "2024-01-01T00:00:00Z",
    "phone": {
      "countryCode": "1",
      "number": "4155551234"
    },
    "email": "john.doe@acme.com"
  }
]

Get representatives for an entity

Authentication

AuthorizationBearer

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

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

Response

This endpoint returns a list of objects.

idstring

nameobject

addressobject

birthDateProvidedboolean

governmentIDProvidedboolean

responsibilitiesobject

createdOndatetime

updatedOndatetime

phoneobject

emailstring

disabledOndatetime

Errors

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

501

Unimplemented