Skip to main content
API docs by Redocly

Evenhand REST API (1.0.0)

Download OpenAPI specification:Download

URL: https://developers.evenhandhq.com License: LicenseRef-Evenhand-Proprietary

Brokerage-facing REST API for the Evenhand deal-management platform.

The Evenhand REST API exposes brokerage-tenant resources (contacts, deals, offers, diligence artifacts) over HTTPS using bearer-token authentication issued from the brokerage settings UI.

All requests are scoped to a single brokerage. The bearer token determines both the brokerage tenant and the set of permitted scopes; nothing about the URL or request body changes the tenant.

Contacts

People and companies tracked by a brokerage outside of any specific deal.

List contacts

Returns contacts visible to the calling brokerage. Paginated.

Authorizations:
bearerAuth
query Parameters
cursor
string

Opaque cursor returned by a previous response.

limit
integer [ 1 .. 200 ]
Default: 50

Page size. Defaults to 50, max 200.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create a contact

Authorizations:
bearerAuth
Request Body schema: application/json
required
type
required
string
Enum: "person" "company"
displayName
required
string non-empty
email
string <email>
phone
string

Responses

Request samples

Content type
application/json
{
  • "type": "person",
  • "displayName": "string",
  • "email": "user@example.com",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "person",
  • "displayName": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieve a contact

Authorizations:
bearerAuth
path Parameters
contactId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "person",
  • "displayName": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}