Client Reference
Organizations
Organizations endpoint reference.
List
Retrieve a list of organizations a particular user has access to.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
params | array | No | [] | Array containing the necessary params. |
php
$response = $client->organizations()->list([]);
Create
Create a new organization for a user.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
values | array | Yes | Organization values, requires name. |
php
$response = $client->organizations()->create([]);
Get
Retrieve the details of a certain organization.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
organizationId | string | Yes | Organization identifier. |
php
$response = $client->organizations()->get('ORGANIZATION_ID');
Update
Modify organization.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
organizationId | string | Yes | Organization identifier. | |
values | array | No | [] | Organization values, e.g. name. |
php
$response = $client->organizations()->update('ORGANIZATION_ID', []);
Delete
Delete an organization. The organization MUST be empty before deleting.
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
organizationId | string | Yes | Organization identifier. |
php
$response = $client->organizations()->delete('ORGANIZATION_ID');