Retrieve a single contact information

GET 
/api/contacts/:id

This API endpoint is designed to provide detailed information about a specific contact, making it a valuable tool for retrieving contact data within your system.

Request

Path Parameters

id stringrequired

Contact identifier

Responses

200

OK - The request was processed successfully.

application/json

Schema

Schema

id integer
name string
type string

Possible values: [legal_entity, person]

country string
address stringnullable
city stringnullable
zip stringnullable
state stringnullable
language string

Possible values: [en, de, fr, it, cs, pl]

selfContact boolean
expenseCategory objectnullable
id integer
name string
expenseCostCenter objectnullable
id integer
name string
expenseVat objectnullable
id integer
name string
value string
autoCompleteExpenseManagement boolean

Whether accounting details from the contact should automatically mark related expense management as completed.

Example (from schema)

{
  "id": 1,
  "name": "AMNIS Treasury Services AG",
  "type": "legal_entity",
  "country": "CH",
  "address": "Baslerstrasse 60",
  "city": "Zürich",
  "zip": "8048",
  "state": "Canton of Zürich",
  "language": "en",
  "selfContact": false,
  "expenseCategory": {
    "id": 1,
    "name": "Travels"
  },
  "expenseCostCenter": {
    "id": 1,
    "name": "Finance"
  },
  "expenseVat": {
    "id": 1,
    "name": "Standard VAT",
    "value": "8.1"
  },
  "autoCompleteExpenseManagement": false
}

401

Unauthorised -- Your access token is wrong.

application/json

Schema

Schema

type string
title string
detail string

Example (from schema)

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

403

Forbidden -- Access to the requested resource or action is forbidden.

application/json

Schema

Schema

type string
title string
detail string

Example (from schema)

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

404

Not Found -- The requested resource could not be found.

application/json

Schema

Schema

title stringnullable

A short, human-readable summary of the problem.

detail stringnullable

A human-readable explanation specific to this occurrence of the problem.

status numbernullable

Default value: 400

instance stringnullable

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

type string

A URI reference that identifies the problem type

Example (from schema)

{
  "title": "string",
  "detail": "string",
  "status": 400,
  "instance": "string",
  "type": "string"
}

Loading...