get

POST

/public/contact/get

• Enclave API server

Get a contact inside the workspace.

Request Body ^required

object

workspaceUuid

required

The UUID of the workspace to create the envelope in.

string

>= 36 characters <= 36 characters

email

required

The email of the contact.

string

<= 255 characters

Responses

200

Default Response

object

contact

required

object

uuid

required

The UUID of the contact.

string

email

required

The email of the contact.

string

firstname

required

The first name of the contact.

string

lastname

required

The last name of the contact.

string

phone

required

Any of:

string

string

null

null

400

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: WORKSPACE_NOT_FOUND CONTACT_NOT_FOUND INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

401

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: AUTHENTICATION_ERROR TUNNEL_ERROR INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

403

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: AUTHORIZATION_ERROR INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string

500

Default Response

object

statusCode

required

HTTP status code

number

error

required

object

code

required

The error code

string

Allowed values: INTERNAL_SERVER_ERROR INVALID_REQUEST_FORMAT

message

required

The error message

string

suggestion

required

A suggestion to resolve the error

string

documentationUrl

required

A URL to the documentation

string

requestId

required

The unique identifier of the request

string

timestamp

required

The timestamp of the response

string

path

required

The path of the request

string