Contacts

Get a contact

get/contacts/{contactId}

Request

Base URL: https://next-api.saturation.io/v1
URL: https://next-api.saturation.io/v1/contacts/{contactId}
Auth: HTTP bearer

Query parameters

expandContactExpand[]

Comma list of related data to inline on contacts (depth ≤ 2). Unknown key returns 400 expand_invalid.

Response

The contact.

idstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

displayNamestring required

Display name for the contact.

namestring nullable

Person or primary contact name.

companystring nullable

titlestring nullable

Role or job title, such as Director of Photography.

type'contractor' | 'employee' | 'company' | 'vendor'

Contact type. Vendors are organizations; contractors and employees are people.

emailstring nullable

phonestring nullable

addressstring nullable

Free-form address as entered.

websitestring nullable

instagramstring nullable

imdbstring nullable

track1099boolean required

Whether this contact is tracked for 1099 reporting.

taxIdLast4string nullable

Last four digits of the tax ID.

hasTaxIdboolean

Whether a tax ID is on file.

notesstring nullable

Markdown notes.

createdAtstring date-time required

updatedAtstring date-time required

Example response

{
  "id": "txn_8f2a1c9e",
  "displayName": "Aerial Imaging LLC",
  "rate": {
    "amount": 152900,
    "currency": "USD"
  },
  "documents": [
    {
      "id": "txn_8f2a1c9e"
    }
  ],
  "transactions": [
    {
      "id": "txn_8f2a1c9e",
      "projectId": "txn_8f2a1c9e",
      "budgetLineId": "txn_8f2a1c9e"
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.