reference

Organization

3 endpoints

GET/api/v2/organization

List Organizations

Requires: ORGANIZATION_list

query parameters

`name`	`string`
`exactMatch`	`boolean`
`excludeOrganizationIds`	`integer (int64)[]`
`restrictOwnAccount`	`boolean`
`accountUUID`	`string (uuid)`
`customFields`	`map<string, object>[]`
`customFieldsJson`	`string`
`sort`	`string`
`page`	`integer` Page to return, starting at 0.
`size`	`integer` Items per page.

Responses

200 OK

PageOrganizationDto

`content`	OrganizationDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

Request

curl -X GET 'https://app.wxrks.com/api/v2/organization' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "content": [
    {}
  ],
  "empty": false,
  "first": false,
  "last": false,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": false,
    "sort": {},
    "unpaged": false
  },
  "size": 0,
  "sort": {
    "empty": false,
    "sorted": false,
    "unsorted": false
  },
  "totalElements": 0,
  "totalPages": 0
}

POST/api/v2/organization

Create Organization

Requires: ORGANIZATION_create

Request body

OrganizationDto

`accountUuid`	`string (uuid)`
`country`	`string`
`customFields`	`map<string, object>[]`
`id`	`integer (int64)`
`logo`	`string`
`mtSettings`	MtSettingsDto
`name`	`string`
`orgUnitDrafts`	OrgUnitCreate[]
`uuid`	`string (uuid)`

Responses

200 OK

OrganizationDto

`accountUuid`	`string (uuid)`
`country`	`string`
`customFields`	`map<string, object>[]`
`id`	`integer (int64)`
`logo`	`string`
`mtSettings`	MtSettingsDto
`name`	`string`
`orgUnitDrafts`	OrgUnitCreate[]
`uuid`	`string (uuid)`

Request

curl -X POST 'https://app.wxrks.com/api/v2/organization' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "country": "string",
  "customFields": [],
  "id": 0,
  "logo": "string",
  "mtSettings": {
    "active": false,
    "credentials": "string",
    "isCredentialValid": false,
    "name": "string",
    "provider": "string",
    "reason": "string",
    "reasonCode": "string",
    "sourceLanguage": "string",
    "targetLanguage": "string",
    "text": "string",
    "translated": "string",
    "type": "DEFAULT",
    "uuid": "string"
  },
  "name": "string",
  "orgUnitDrafts": [],
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Response 200

{
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "country": "string",
  "customFields": [
    {}
  ],
  "id": 0,
  "logo": "string",
  "mtSettings": {
    "accountUuid": "string",
    "active": false,
    "credentials": "string",
    "isCredentialValid": false,
    "name": "string",
    "provider": "string",
    "reason": "string",
    "reasonCode": "string",
    "sourceLanguage": "string",
    "targetLanguage": "string",
    "text": "string",
    "translated": "string",
    "type": "DEFAULT",
    "updateAt": 0,
    "updatedAt": 0,
    "uuid": "string"
  },
  "name": "string",
  "orgUnitDrafts": [
    {}
  ],
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

GET/api/v2/organization/{organizationUUID}

Get Organization

Requires: ORGANIZATION_get_by_id

path parameters

organizationUUIDrequired string (uuid)

Responses

200 OK

OrganizationDto

`accountUuid`	`string (uuid)`
`country`	`string`
`customFields`	`map<string, object>[]`
`id`	`integer (int64)`
`logo`	`string`
`mtSettings`	MtSettingsDto
`name`	`string`
`orgUnitDrafts`	OrgUnitCreate[]
`uuid`	`string (uuid)`

Request

curl -X GET 'https://app.wxrks.com/api/v2/organization/{organizationUUID}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "country": "string",
  "customFields": [
    {}
  ],
  "id": 0,
  "logo": "string",
  "mtSettings": {
    "accountUuid": "string",
    "active": false,
    "credentials": "string",
    "isCredentialValid": false,
    "name": "string",
    "provider": "string",
    "reason": "string",
    "reasonCode": "string",
    "sourceLanguage": "string",
    "targetLanguage": "string",
    "text": "string",
    "translated": "string",
    "type": "DEFAULT",
    "updateAt": 0,
    "updatedAt": 0,
    "uuid": "string"
  },
  "name": "string",
  "orgUnitDrafts": [
    {}
  ],
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}