Billing

Retrieve contact

get/contacts/{id}/

Request

Base URL
https://api.piriod.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/piriod/apis/piriod-api/docs/contacts/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

The contact.

idstring

customerstring nullable

Customer ID this contact belongs to.

orgunitstring nullable

Organisation unit ID. Optional sub-grouping inside a customer.

namestring required

emailstring email required

phonestring nullable

invoicingboolean

Whether this contact receives invoice emails.

collectionsboolean

Whether this contact receives collection reminders.

createdstring date-time

updatedstring date-time

{
  "id": "con_01H8XYZ123ABC"
}

No recorded changes to this operation across all 1 revision of this API.