Get Organisation Services
This endpoint retrieves a list of services associated with an organisation, providing detailed information about each service, including its name, type, and status. Users can view key attributes such as service functionality, dependencies, and supported features. Additionally, the response includes the organisation and relevant infrastructure details, along with active service endpoints, such as hosts, recorders, or workflow integrations.
To enhance flexibility, this endpoint supports additional parameters to limit the number of results returned, ensuring efficient data handling. A continuation token can also be used to paginate through large datasets, allowing you to retrieve workflows in manageable chunks for improved performance and scalability.
Syntax: see 'CCall Structure
Type = 'GET'
|
'https://connect.cambrionix.com/api/v1/organizations/organisation-id/services?token=token&limit=return-number' |
| Variable | Description |
|---|---|
| organisation-id | This is the unique id of the organisation as a unique 128-bit number |
| token | Continuation token |
| return-number | Number of records to return |
Returns:
|
{ "created": { "time": time, "user": { "id": "user-id", "detail": { "givenName": "given-name", "surname": "surname", "displayName": "display-name", "email": "account-email" } } }, "updated": { "time": time }, "id": "service-id, "activated": activated, "roles": [ { "id": "role-id", "name": "role-name", "type": "role-type", "description": "role-description", "permissions": { "allowed": ["permission"], "denied": ["permission"] } } ], "type": "service-type", "address": { "hostName": "service-hostname", "port": service-port }, "computer": { "id": "computer-id", "name": "computer-name" }, "organization": { "id": "organisation-id", "name": "organisaion-name }, "secret": "service-secret" }, "_metadata": { "total": total-entries } |
| Output | Description |
|---|---|
| time | The hub time, shown as an integer in ms |
| computer-id | This is the id of the computer as a unique 128-bit number |
| user-id | This is the id of the user as a unique 128-bit number |
| given-name | The first name of the user |
| surname | The surname of the user |
| display-name | The account name of the user |
| account-email | The email of the user |
| service-id | This is the id of the service as a unique 128-bit number |
| activated | Is the service activated or not |
| role-id | This is the id of the role as a unique 128-bit number |
| role-name | The name of the role |
| role-type | The type of role such as organisation or Built-in role |
| role-description | The description of the role |
| permission | The associated permission names and descriptions |
| service-type | This is the type of service e.g. cloud or host |
| service-hostname | This is the hostname of the service |
| service-port | This is the port the service is using |
| computer-id | This is the id of the computer as a unique 128-bit number |
| computer-name | The name of the computer |
| organisation-id | This is the id of the organisation as a unique 128-bit number |
| organisation-name | This is the name of the organisation |
| service-secret | The secret of the service |
| total-entries | The total amount of entries |
Example
curl -X 'GET' \
'https://connect.cambrionix.com/api/v1/organizations/40f5a1a7-3119-4961-8493-866c4053b7eb/services' \
-H 'accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIuknVBw'Returns
This response has been truncated for clarity within the manual.
{
"created": {
"time": 1712828249564,
"user": {
"id": "46bbf7f5-1794-411d-b42b-97ab2fe12460",
"detail": {
"givenName": "Nick",
"surname": "Metcalfe",
"displayName": "unknown",
"email": "nicholas.metcalfe@cambrionix.com"
}
}
},
"updated": {
"time": 1739954951602
},
"id": "bd2fd2d4-3f39-4e0b-a1f7-e4e8cc331ff9",
"activated": true,
"roles": [
{
"id": "00000000-0000-0000-0000-000000000005",
"name": "Hardware API Service Role",
"type": "built-in",
"description": "Contains permissions required by the Hardware API",
"permissions": {
"allowed": [],
"denied": []
}
}
],
"type": "host",
"address": {
"hostName": "cbrxci-014.api.cambrionix.com",
"port": 43424
},
"computer": {
"id": "08787020-2085-5D9D-8A7D-FCFE007CA5E4",
"name": "CBRXCI-014"
},
"organization": {
"id": "40f5a1a7-3119-4961-8493-866c4053b7eb",
"name": "Connect Premium"
},
"secret": "ifnGBttfs="
},
"_metadata": {
"total": 23
}Errors
If there is an error in the API method then JSON-RPC Error Object a will be returned