Skip to main content
GET
/
contacts
/
{id}
Retrieve contact
curl --request GET \
  --url https://api.piriod.com/contacts/{id}/ \
  --header 'Authorization: <api-key>' \
  --header 'x-simple-workspace: <x-simple-workspace>'
{
  "name": "<string>",
  "email": "jsmith@example.com",
  "id": "con_01H8XYZ123ABC",
  "customer": "<string>",
  "orgunit": "<string>",
  "phone": "<string>",
  "invoicing": true,
  "collections": true,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://piriod-d406ac55.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

​
x-simple-workspace
string
required

Workspace (account) identifier. Required for every request.

​
x-piriod-test-mode
boolean
default:false

Whether to operate against test-mode data. Defaults to false.

Path Parameters

​
id
string
required

Resource identifier.

Response

The contact.

​
name
string
required
Maximum string length: 64
​
email
string<email>
required
​
id
string
read-only
Example:

"con_01H8XYZ123ABC"

​
customer
string | null

Customer ID this contact belongs to.

​
orgunit
string | null

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

​
phone
string | null
Maximum string length: 12
​
invoicing
boolean
default:true

Whether this contact receives invoice emails.

​
collections
boolean
default:true

Whether this contact receives collection reminders.

​
created
string<date-time>
read-only
​
updated
string<date-time>
read-only