VRPlatformVRPlatform
Contacts

/contacts/{id}

Get contact by ID

GET
/contacts/{id}
X-API-Key<token>

API key provided in dashboard

In: header

Path Parameters

id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "address": {
    "full": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "stateCode": "string",
    "countryCode": "string"
  },
  "type": "owner",
  "email": "user@example.com",
  "firstName": "string",
  "name": "string",
  "phone": "string",
  "connectionId": "string",
  "companyType": "c_corporation",
  "taxIdentifier": "string",
  "uniqueRef": "string",
  "status": "active",
  "payoutAccountId": "f16cca2a-0289-41e7-992d-7fd2e711757a",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "shortRef": "string",
  "source": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "string",
    "status": "active",
    "appId": "string",
    "appIcon": "string"
  },
  "ownershipPeriods": [
    {
      "listingId": "string",
      "split": 0,
      "startAt": "string",
      "endAt": "string"
    }
  ],
  "activeOwnerships": [
    {
      "listingId": "string",
      "split": 0,
      "startAt": "string",
      "endAt": "string"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}