Company

Endpoints relating to Company objects

List company objects

Returns a list of companies in the network.

Request
query Parameters
page
integer >= 1
Default: 1

Page number of the page to retrieve

Example: page=1
per
integer [ 1 .. 100 ]
Default: 20

Count of items in each page. Should be between 1 and 100 (inclusive)

Example: per=20
f.ref
string

The ref for the company.

f.metadata.YOUR_METADATA_KEY
string

Only return companies that have a specific metadata key-value pair. Multiple metadata filters can be added to a single query. If there are multiple metadata filters each with the same metadata key, then the filter will return companies matching any of the specified metadata values for that metadata key.

Responses
200

collection of companies

Response Schema: application/json
_object
string
self
string
version
integer
object
_object
string
prev
string or null
next
string or null
total_count
integer
Array of objects (Company)
get/network/companies
Response samples
application/json

Success

{
  • "_object": "/api/response",
  • "version": 2,
  • "data": {
    • "_object": "/api/collections/paginated",
    • "next": null,
    • "total_count": 121,
    • "data": [
      • {
        }
      ]
    }
}

Create a new company object

Request
Request Body schema: application/json
name
required
string

Always required. Name of the company.

ref
string

Your custom string used to refer to the company

Responses
200

The created company

Response Schema: application/json
_object
string
self
string
version
integer
object (Company)
_object
string

Type of the object. Always /network/company for this object.

id
string

Unique identifier for the company

metadata
object (Metadata)

Set of custom key-values specific to the object. The keys are strings and values are arrays of strings. The set of valid keys is always the consignee's list of keys, even if call was made by a different party.

name
string
ref
string
editable
boolean
Array of objects (CompanyEntity)
object (GenericCollectionRef)
object (GenericCollectionRef)
post/network/companies
Request samples
application/json
{
  • "name": "Zoomit",
  • "ref": "zoomit-ref"
}
Response samples
application/json

Success

{}

Retrieve a company

Retrieves the details of a single company.

Request
path Parameters
id
required
string

The unique id for the requested company

Responses
200

Success

Response Schema: application/json
_object
string
self
string
version
integer
object (Company)
_object
string

Type of the object. Always /network/company for this object.

id
string

Unique identifier for the company

metadata
object (Metadata)

Set of custom key-values specific to the object. The keys are strings and values are arrays of strings. The set of valid keys is always the consignee's list of keys, even if call was made by a different party.

name
string
ref
string
editable
boolean
Array of objects (CompanyEntity)
object (GenericCollectionRef)
object (GenericCollectionRef)
get/network/companies/{id}
Response samples
application/json

Success

{
  • "_object": "/api/response",
  • "version": 2,
  • "data": {
    • "_object": "/network/company",
    • "id": "ABC123",
    • "metadata": { },
    • "name": "CompanyFoo",
    • "ref": "ref_for_company",
    • "editable": true,
    • "entities": [
      • {
        }
      ],
    • "locations": {},
    • "contacts": {}
    }
}

Update an existing company

Request
path Parameters
id
required
string

The unique id for the requested company

Example: K67EZV1K8cQ5afQErZwk1Q
Request Body schema: application/json
name
string

Updated name of the company.

ref
string

Updated ref of the company

Responses
200

The updated company

Response Schema: application/json
_object
string
self
string
version
integer
object (Company)
_object
string

Type of the object. Always /network/company for this object.

id
string

Unique identifier for the company

metadata
object (Metadata)

Set of custom key-values specific to the object. The keys are strings and values are arrays of strings. The set of valid keys is always the consignee's list of keys, even if call was made by a different party.

name
string
ref
string
editable
boolean
Array of objects (CompanyEntity)
object (GenericCollectionRef)
object (GenericCollectionRef)
patch/network/companies/{id}
Request samples
application/json
{
  • "name": "Updated Zoomit",
  • "ref": "zoomit_ref"
}
Response samples
application/json

Success

{}

Retrieve your company

Retrieves the details of your own organization.

Responses
200

Success

Response Schema: application/json
_object
string
self
string
version
integer
object (Company)
_object
string

Type of the object. Always /network/company for this object.

id
string

Unique identifier for the company

metadata
object (Metadata)

Set of custom key-values specific to the object. The keys are strings and values are arrays of strings. The set of valid keys is always the consignee's list of keys, even if call was made by a different party.

name
string
ref
string
editable
boolean
Array of objects (CompanyEntity)
object (GenericCollectionRef)
object (GenericCollectionRef)
get/network/me/companies
Response samples
application/json

Success

{
  • "_object": "/api/response",
  • "version": 2,
  • "data": {
    • "_object": "/network/company",
    • "id": "ABC123",
    • "name": "CompanyFoo",
    • "ref": "ref_for_company",
    • "editable": true,
    • "entities": [
      • {
        }
      ],
    • "locations": {},
    • "contacts": {}
    }
}