Get a contact

GET 
/api/contacts/{id}

Required permissions:

• crm.view: allows view resources.

Here the dedicated support page.

Request

Path Parameters

id integerrequired

Possible values: Value must match regular expression [0-9]+

The ID of the contact to view

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

The unique identifier of the resource

created_at date-timerequired

The date and time when the resource was created

updated_at date-timerequired

The date and time when the resource was last updated

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-08-29T09:30:33.214Z",
  "updated_at": "2025-08-29T09:30:33.214Z",
  "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"
}

400

Validation failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

Example (from schema)

{
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

403

Forbidden

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

404

Not found

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "not_found",
  "message": "string"
}

Loading...