Get a Org

Get a Org

curl --request GET \
  --url https://api.zivio.net/api/v4/orgs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'zivio-tenant-id: <api-key>'

import requests

url = "https://api.zivio.net/api/v4/orgs/{id}"

headers = {
    "Authorization": "Bearer <token>",
    "zivio-tenant-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'zivio-tenant-id': '<api-key>'}
};

fetch('https://api.zivio.net/api/v4/orgs/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.zivio.net/api/v4/orgs/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "zivio-tenant-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zivio.net/api/v4/orgs/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("zivio-tenant-id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zivio.net/api/v4/orgs/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["zivio-tenant-id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": 101,
  "uuid": "Example uuid",
  "external_ref": "Example external_ref",
  "name": "Acme Corporation",
  "is_external_client": true,
  "is_supplier": true,
  "supplier_id": 501,
  "url": "Example url",
  "linkedin_url": "Example linkedin_url",
  "billing_email": "Example billing_email",
  "address": null,
  "invoice_address": null,
  "payment_terms_in_days": 30,
  "cis_contractor": null,
  "financial_year_end_day": 101,
  "financial_year_end_month": 101,
  "time_zone": "Example time_zone",
  "ai_services": true,
  "scopeiq_share_ai_usage": true,
  "custom_fields": {
    "department": "Engineering",
    "priority": "high",
    "cost_code": "CC-001"
  },
  "settings": {
    "default_fee_methodology": null,
    "cis_contractor": false,
    "payment_terms_in_days": null
  },
  "archived_at": "2024-01-16T10:30:00+00:00",
  "created_at": "2024-01-16T10:30:00+00:00",
  "updated_at": "2024-01-16T10:30:00+00:00",
  "cost_centers": [
    {
      "id": 101,
      "org_id": 501,
      "name": "Acme Corporation",
      "code": "Example code",
      "external_ref": "Example external_ref",
      "is_active": true,
      "created_at": "2024-01-16T10:30:00+00:00",
      "updated_at": "2024-01-16T10:30:00+00:00"
    },
    {
      "id": 102,
      "org_id": 502,
      "name": "Global Services Ltd",
      "code": "Example code",
      "external_ref": "Example external_ref",
      "is_active": true,
      "created_at": "2024-01-17T10:30:00+00:00",
      "updated_at": "2024-01-17T10:30:00+00:00"
    }
  ],
  "org_units": [
    {
      "id": 101,
      "org_id": 501,
      "parent_id": 501,
      "name": "Acme Corporation",
      "unit_type": 101,
      "external_ref": "Example external_ref",
      "created_at": "2024-01-16T10:30:00+00:00",
      "updated_at": "2024-01-16T10:30:00+00:00"
    },
    {
      "id": 102,
      "org_id": 502,
      "parent_id": 502,
      "name": "Global Services Ltd",
      "unit_type": 102,
      "external_ref": "Example external_ref",
      "created_at": "2024-01-17T10:30:00+00:00",
      "updated_at": "2024-01-17T10:30:00+00:00"
    }
  ],
  "org_users": [
    {
      "id": 101,
      "first_name": "Demo",
      "last_name": "User",
      "email": "user1@example.com",
      "org_id": 501,
      "org_name": "Acme Corporation"
    },
    {
      "id": 102,
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "user2@example.com",
      "org_id": 502,
      "org_name": "Global Services Ltd"
    }
  ]
}

GET

orgs

{id}

Get a Org

curl --request GET \
  --url https://api.zivio.net/api/v4/orgs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'zivio-tenant-id: <api-key>'

import requests

url = "https://api.zivio.net/api/v4/orgs/{id}"

headers = {
    "Authorization": "Bearer <token>",
    "zivio-tenant-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'zivio-tenant-id': '<api-key>'}
};

fetch('https://api.zivio.net/api/v4/orgs/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.zivio.net/api/v4/orgs/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "zivio-tenant-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zivio.net/api/v4/orgs/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("zivio-tenant-id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zivio.net/api/v4/orgs/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["zivio-tenant-id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": 101,
  "uuid": "Example uuid",
  "external_ref": "Example external_ref",
  "name": "Acme Corporation",
  "is_external_client": true,
  "is_supplier": true,
  "supplier_id": 501,
  "url": "Example url",
  "linkedin_url": "Example linkedin_url",
  "billing_email": "Example billing_email",
  "address": null,
  "invoice_address": null,
  "payment_terms_in_days": 30,
  "cis_contractor": null,
  "financial_year_end_day": 101,
  "financial_year_end_month": 101,
  "time_zone": "Example time_zone",
  "ai_services": true,
  "scopeiq_share_ai_usage": true,
  "custom_fields": {
    "department": "Engineering",
    "priority": "high",
    "cost_code": "CC-001"
  },
  "settings": {
    "default_fee_methodology": null,
    "cis_contractor": false,
    "payment_terms_in_days": null
  },
  "archived_at": "2024-01-16T10:30:00+00:00",
  "created_at": "2024-01-16T10:30:00+00:00",
  "updated_at": "2024-01-16T10:30:00+00:00",
  "cost_centers": [
    {
      "id": 101,
      "org_id": 501,
      "name": "Acme Corporation",
      "code": "Example code",
      "external_ref": "Example external_ref",
      "is_active": true,
      "created_at": "2024-01-16T10:30:00+00:00",
      "updated_at": "2024-01-16T10:30:00+00:00"
    },
    {
      "id": 102,
      "org_id": 502,
      "name": "Global Services Ltd",
      "code": "Example code",
      "external_ref": "Example external_ref",
      "is_active": true,
      "created_at": "2024-01-17T10:30:00+00:00",
      "updated_at": "2024-01-17T10:30:00+00:00"
    }
  ],
  "org_units": [
    {
      "id": 101,
      "org_id": 501,
      "parent_id": 501,
      "name": "Acme Corporation",
      "unit_type": 101,
      "external_ref": "Example external_ref",
      "created_at": "2024-01-16T10:30:00+00:00",
      "updated_at": "2024-01-16T10:30:00+00:00"
    },
    {
      "id": 102,
      "org_id": 502,
      "parent_id": 502,
      "name": "Global Services Ltd",
      "unit_type": 102,
      "external_ref": "Example external_ref",
      "created_at": "2024-01-17T10:30:00+00:00",
      "updated_at": "2024-01-17T10:30:00+00:00"
    }
  ],
  "org_users": [
    {
      "id": 101,
      "first_name": "Demo",
      "last_name": "User",
      "email": "user1@example.com",
      "org_id": 501,
      "org_name": "Acme Corporation"
    },
    {
      "id": 102,
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "user2@example.com",
      "org_id": 502,
      "org_name": "Global Services Ltd"
    }
  ]
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client credentials. The access token from POST /oauth/token is sent as a bearer token. Request only the scopes you need.

zivio-tenant-id

string

header

required

Your Zivio organisation identifier. The regional API endpoints serve every Zivio organisation, so each request must identify yours.

Path Parameters

integer

required

Org ID

Response

Org details

integer

uuid

string

external_ref

string

name

string

is_external_client

boolean

Example:

true

is_supplier

boolean

Example:

true

supplier_id

integer

url

string

linkedin_url

string

billing_email

string

address

object

Show child attributes

invoice_address

object

Show child attributes

payment_terms_in_days

integer

cis_contractor

boolean

Example:

true

financial_year_end_day

integer

financial_year_end_month

integer

time_zone

string

ai_services

boolean

Example:

true

Example:

true

custom_fields

object

Key-value pairs of custom field data

Show child attributes

settings

object

Show child attributes

archived_at

string

created_at

string

updated_at

string

cost_centers

object[]

Show child attributes

org_units

object[]

Show child attributes

org_users

object[]

Show child attributes

Authentication

Welcome

Bids

Eois

Eoi Responses

Invoices

Milestones

Offers

Projects

Supplier Lists

Suppliers

Variation Orders

Users

Skill Taxonomies

Tax Types

Bank Accounts

Raw Scorecard Entries

Reviews

Supplier Users

Orgs

Purchase Orders

Notes

Tasks

Authorizations

Path Parameters

Response