Retrieve an Org by ID

curl --request GET \
  --url https://api.zivio.net/api/v3/orgs/{id} \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>'

{
  "id": "23",
  "name": "Demonstration Inc.",
  "is_external_client": "false",
  "url": "www.example.com",
  "billing_email": "[email protected]",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-12-25",
  "address": {
    "id": "326",
    "line1": "326",
    "line2": "Westbourne Grove",
    "city": "Brighton",
    "region": "East Sussex",
    "postcode": "BN99 9XX",
    "country_code": "GB",
    "formatted": "326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"
  },
  "invoice_address": {
    "id": "326",
    "line1": "326",
    "line2": "Westbourne Grove",
    "city": "Brighton",
    "region": "East Sussex",
    "postcode": "BN99 9XX",
    "country_code": "GB",
    "formatted": "326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"
  },
  "custom_fields": {
    "key": "value"
  },
  "settings": {
    "default_fee_methodology": "markup",
    "cis_contractor": "true",
    "payment_terms_in_days": "30"
  }
}

GET

orgs

{id}

Retrieve an Org by ID

curl --request GET \
  --url https://api.zivio.net/api/v3/orgs/{id} \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>'

{
  "id": "23",
  "name": "Demonstration Inc.",
  "is_external_client": "false",
  "url": "www.example.com",
  "billing_email": "[email protected]",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-12-25",
  "address": {
    "id": "326",
    "line1": "326",
    "line2": "Westbourne Grove",
    "city": "Brighton",
    "region": "East Sussex",
    "postcode": "BN99 9XX",
    "country_code": "GB",
    "formatted": "326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"
  },
  "invoice_address": {
    "id": "326",
    "line1": "326",
    "line2": "Westbourne Grove",
    "city": "Brighton",
    "region": "East Sussex",
    "postcode": "BN99 9XX",
    "country_code": "GB",
    "formatted": "326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"
  },
  "custom_fields": {
    "key": "value"
  },
  "settings": {
    "default_fee_methodology": "markup",
    "cis_contractor": "true",
    "payment_terms_in_days": "30"
  }
}

Authorizations

X-API-Key

string

header

required

zivio-tenant-id

string

header

required

Path Parameters

integer

required

Response

integer

Example:

"23"

name

string

Example:

"Demonstration Inc."

is_external_client

string

Example:

"false"

url

string

Example:

"www.example.com"

billing_email

string

Example:

"[email protected]"

created_at

string<date-time>

updated_at

string<date>

address

object

Show child attributes

address.id

string

Example:

"326"

address.line1

string

Example:

"326"

address.line2

string

Example:

"Westbourne Grove"

address.city

string

Example:

"Brighton"

address.region

string

Example:

"East Sussex"

address.postcode

string

Example:

"BN99 9XX"

address.country_code

string

Example:

"GB"

address.formatted

string

Example:

"326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"

invoice_address

object

Show child attributes

invoice_address.id

integer

Example:

"326"

invoice_address.line1

string

Example:

"326"

invoice_address.line2

string

Example:

"Westbourne Grove"

invoice_address.city

string

Example:

"Brighton"

invoice_address.region

string

Example:

"East Sussex"

invoice_address.postcode

string

Example:

"BN99 9XX"

invoice_address.country_code

string

Example:

"GB"

invoice_address.formatted

string

Example:

"326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"

custom_fields

object

Show child attributes

custom_fields.key

string

Example:

"value"

settings

object

Show child attributes

settings.default_fee_methodology

string

Example:

"markup"

settings.cis_contractor

string

Example:

"true"

settings.payment_terms_in_days

string

Example:

"30"

Create an Org Delete an Org by ID

⌘I

Endpoints

Authorizations

Path Parameters

Response