Skip to main content
GET
/
suppliers
/
{id}
Retrieve supplier
curl --request GET \
  --url https://api.piriod.com/suppliers/{id}/ \
  --header 'Authorization: <api-key>' \
  --header 'x-simple-workspace: <x-simple-workspace>'
{
  "name": "<string>",
  "country": "<string>",
  "id": 123,
  "tax_id": "<string>",
  "state": 123,
  "currency": "USD",
  "address": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "website": "<string>",
  "tax_settings": {},
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

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 supplier.

​
name
string
required
Maximum string length: 64
​
country
string
required

Country ID.

​
id
integer
read-only
​
tax_id
string | null
Maximum string length: 32
​
state
integer | null
​
currency
string
default:USD

ISO currency code.

​
address
string | null
Maximum string length: 64
​
email
string<email> | null
​
phone
string | null
Maximum string length: 16
​
website
string<uri> | null
​
tax_settings
object

Country-specific tax-agency configuration.

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