Get a contact

GET 
/api/contacts/:id

• crm.view: allows view resources.

Here the dedicated support page.

Request

Path Parameters

id stringrequired

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

Responses

200

Returns the requested contact.

application/json

Schema

Schema

id integerrequired

Possible values: >= 1

created_at date-timerequired
updated_at date-timerequired
client_id integerrequired

Possible values: >= 1

ID of the client

email stringrequired

Possible values: <= 150 characters

name stringrequired

Possible values: <= 100 characters

surname stringrequired

Possible values: <= 100 characters

role string

Possible values: <= 75 characters

notes string
linkedin string

Possible values: <= 250 characters

description string
telephone integer

Possible values: <= 100 characters

Example (from schema)

{
  "id": 1,
  "created_at": "2025-01-21T10:16:02.205Z",
  "updated_at": "2025-01-21T10:16:02.205Z",
  "client_id": 1,
  "email": "client@email.com",
  "name": "Client name",
  "surname": "Client surname",
  "role": "Client role",
  "notes": "Some notes about the client",
  "linkedin": "https://www.linkedin.com/in/example",
  "description": "A brief description of the client",
  "telephone": "123456789"
}

403

Forbidden

404

Not found

Loading...