Contacts

get

Query parameters

pageintegerOptionalDefault: 1

Responses

200

Successful response

application/json

totalCountnumberRequired

totalPagesnumberRequired

currentPagenumberRequired

default

Error response

application/json

get

/contacts

HTTPcURLJavaScriptPython

GET /api/v1/contacts HTTP/1.1
Host: app.companycontacts.timeghost-solutions.com
Accept: */*

{
  "contacts": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "middleName": "text",
      "displayName": "text",
      "title": "text",
      "birthday": "2026-03-11T23:10:25.112Z",
      "image": "text",
      "anniversary": "2026-03-11T23:10:25.112Z",
      "spouseName": "text",
      "jobTitle": "text",
      "isDeleted": true,
      "createdBy": {
        "id": "text",
        "lastName": "text",
        "firstName": "text",
        "name": "text",
        "email": "text",
        "createdAt": "2026-03-11T23:10:25.112Z",
        "updatedAt": "2026-03-11T23:10:25.112Z",
        "language": "text",
        "image": "text"
      },
      "optionalEmails": [
        {
          "id": "text",
          "title": "text"
        }
      ],
      "optionalPhones": [
        {
          "id": "text",
          "title": "text"
        }
      ],
      "addresses": [
        {
          "id": 1,
          "street": "text",
          "city": "text",
          "state": "text",
          "postalCode": "text",
          "countryOrRegion": "text"
        }
      ],
      "vaults": [
        {
          "id": "text",
          "title": "text",
          "description": "text",
          "createdAt": "2026-03-11T23:10:25.112Z",
          "updatedAt": "2026-03-11T23:10:25.112Z",
          "workspaceId": "text",
          "default": true
        }
      ]
    }
  ],
  "totalCount": 1,
  "totalPages": 1,
  "currentPage": 1
}

post

Body

application/json

microsoftIdstringOptional

firstNamestringOptional

lastNamestringOptional

middleNamestringOptional

displayNamestringRequired

titlestringOptional

notestringOptional

companyIdnumberOptional

companyTitlestringOptional

jobTitlestringOptional

vaultIdsstring[]Optional

spouseNamestringOptional

birthdaystringOptional

anniversarystringOptional

containersnumber[]Optional

Responses

200

Successful response

application/json

idnumberRequired

microsoftIdstring · nullableRequired

firstNamestring · nullableRequired

lastNamestring · nullableRequired

middleNamestring · nullableRequired

displayNamestringRequired

titlestring · nullableRequired

notestring · nullableRequired

companyIdnumber · nullableRequired

jobTitlestring · nullableRequired

spouseNamestring · nullableRequired

birthdaystring · date-time · nullableRequired

anniversarystring · date-time · nullableRequired

imagestring · nullableRequired

default

Error response

application/json

post

/contacts

HTTPcURLJavaScriptPython

POST /api/v1/contacts HTTP/1.1
Host: app.companycontacts.timeghost-solutions.com
Content-Type: application/json
Accept: */*
Content-Length: 540

{
  "microsoftId": "text",
  "firstName": "text",
  "lastName": "text",
  "middleName": "text",
  "displayName": "text",
  "title": "text",
  "note": "text",
  "companyId": 1,
  "companyTitle": "text",
  "jobTitle": "text",
  "vaultIds": [
    "text"
  ],
  "spouseName": "text",
  "birthday": "text",
  "anniversary": "text",
  "optionalEmails": [
    {
      "id": "text",
      "title": "text",
      "isTeams": true
    }
  ],
  "optionalPhones": [
    {
      "id": "text",
      "title": "text",
      "typeId": 1
    }
  ],
  "addresses": [
    {
      "street": "text",
      "countryOrRegion": "text",
      "postalCode": "text",
      "state": "text",
      "city": "text",
      "typeId": 1
    }
  ],
  "containers": [
    1
  ],
  "customFields": [
    null
  ]
}

{
  "id": 1,
  "microsoftId": "text",
  "firstName": "text",
  "lastName": "text",
  "middleName": "text",
  "displayName": "text",
  "title": "text",
  "note": "text",
  "companyId": 1,
  "jobTitle": "text",
  "vaults": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "createdAt": "2026-03-11T23:10:25.112Z",
      "updatedAt": "2026-03-11T23:10:25.112Z",
      "workspaceId": "text",
      "default": true
    }
  ],
  "spouseName": "text",
  "birthday": "2026-03-11T23:10:25.112Z",
  "anniversary": "2026-03-11T23:10:25.112Z",
  "optionalEmails": [
    {
      "id": "text",
      "title": "text",
      "isTeams": true
    }
  ],
  "optionalPhones": [
    {
      "id": "text",
      "title": "text",
      "typeId": 1
    }
  ],
  "addresses": [
    {
      "id": 1,
      "street": "text",
      "city": "text",
      "countryOrRegion": "text",
      "postalCode": "text",
      "state": "text",
      "typeId": 1
    }
  ],
  "image": "text"
}

get

Path parameters

idnumberRequired

Responses

200

Successful response

application/json

idnumberRequired

firstNamestring · nullableRequired

lastNamestring · nullableRequired

middleNamestring · nullableOptional

displayNamestringRequired

titlestring · nullableOptional

birthdaystring · date-time · nullableOptional

imagestring · nullableOptional

anniversarystring · date-time · nullableOptional

spouseNamestring · nullableOptional

jobTitlestring · nullableOptional

isDeletedbooleanRequired

default

Error response

application/json

get

/contacts/{id}

HTTPcURLJavaScriptPython

GET /api/v1/contacts/{id} HTTP/1.1
Host: app.companycontacts.timeghost-solutions.com
Accept: */*

{
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "middleName": "text",
  "displayName": "text",
  "title": "text",
  "birthday": "2026-03-11T23:10:25.112Z",
  "image": "text",
  "anniversary": "2026-03-11T23:10:25.112Z",
  "spouseName": "text",
  "jobTitle": "text",
  "isDeleted": true,
  "createdBy": {
    "id": "text",
    "lastName": "text",
    "firstName": "text",
    "name": "text",
    "email": "text",
    "createdAt": "2026-03-11T23:10:25.112Z",
    "updatedAt": "2026-03-11T23:10:25.112Z",
    "language": "text",
    "image": "text"
  },
  "optionalEmails": [
    {
      "id": "text",
      "title": "text"
    }
  ],
  "optionalPhones": [
    {
      "id": "text",
      "title": "text"
    }
  ],
  "addresses": [
    {
      "id": 1,
      "street": "text",
      "city": "text",
      "state": "text",
      "postalCode": "text",
      "countryOrRegion": "text"
    }
  ],
  "vaults": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "createdAt": "2026-03-11T23:10:25.112Z",
      "updatedAt": "2026-03-11T23:10:25.112Z",
      "workspaceId": "text",
      "default": true
    }
  ]
}

put

Path parameters

idnumberRequired

Body

application/json

microsoftIdstringOptional

firstNamestringOptional

lastNamestringOptional

middleNamestringOptional

displayNamestringRequired

titlestringOptional

notestringOptional

companyIdnumberOptional

companyTitlestringOptional

jobTitlestringOptional

vaultIdsstring[]Optional

spouseNamestringOptional

birthdaystringOptional

anniversarystringOptional

Responses

200

Successful response

application/json

idnumberRequired

microsoftIdstring · nullableRequired

firstNamestring · nullableRequired

lastNamestring · nullableRequired

middleNamestring · nullableRequired

displayNamestringRequired

titlestring · nullableRequired

notestring · nullableRequired

companyIdnumber · nullableRequired

jobTitlestring · nullableRequired

spouseNamestring · nullableRequired

birthdaystring · date-time · nullableRequired

anniversarystring · date-time · nullableRequired

imagestring · nullableRequired

default

Error response

application/json

put

/contacts/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/contacts/{id} HTTP/1.1
Host: app.companycontacts.timeghost-solutions.com
Content-Type: application/json
Accept: */*
Content-Length: 262

{
  "microsoftId": "text",
  "firstName": "text",
  "lastName": "text",
  "middleName": "text",
  "displayName": "text",
  "title": "text",
  "note": "text",
  "companyId": 1,
  "companyTitle": "text",
  "jobTitle": "text",
  "vaultIds": [
    "text"
  ],
  "spouseName": "text",
  "birthday": "text",
  "anniversary": "text"
}

{
  "id": 1,
  "microsoftId": "text",
  "firstName": "text",
  "lastName": "text",
  "middleName": "text",
  "displayName": "text",
  "title": "text",
  "note": "text",
  "companyId": 1,
  "jobTitle": "text",
  "vaults": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "createdAt": "2026-03-11T23:10:25.112Z",
      "updatedAt": "2026-03-11T23:10:25.112Z",
      "workspaceId": "text",
      "default": true
    }
  ],
  "spouseName": "text",
  "birthday": "2026-03-11T23:10:25.112Z",
  "anniversary": "2026-03-11T23:10:25.112Z",
  "image": "text"
}

delete

Path parameters

idstringRequired

Responses

200

Successful response

application/json

objectOptional

default

Error response

application/json

delete

/contacts/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/contacts/{id} HTTP/1.1
Host: app.companycontacts.timeghost-solutions.com
Accept: */*

{}