POST
/
orgs
curl --request POST \
  --url https://api.zivio.net/api/v3/orgs \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>' \
  --data '{
  "org": {
    "name": "My New Organistation",
    "is_external_client": true,
    "url": "https://www.example.com"
  }
}'
{
  "id": "23",
  "name": "Demonstration Inc.",
  "is_external_client": "false",
  "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

Body

application/json
​
org
object

Response

200
application/json
ok
​
id
integer
Example:

"23"

​
name
string
Example:

"Demonstration Inc."

​
is_external_client
string
Example:

"false"

​
created_at
string
​
updated_at
string
​
address
object
​
invoice_address
object
​
custom_fields
object
​
settings
object
Retrieve all orgs, filter by queryRetrieve an Org by ID