v1

latestSwagger 2.02026-07-13107214235.7 KB

Workgroup

List the workgroups

get/v1/workgroups

Query parameters

workgroup_namestring

Workgroup Name

workgroup_typesstring[]

1000001 for Buyer, 1000002 for supplier, 1000003 for agent, 1000004 for Broker/Outsourcer and 1000005 for Partner

Response

Successful retrieval

status_codeinteger

status_reasonstring

Example response

{
  "results": [
    {
      "parent_workgroup": {
        "workgroup_name": "sample workgroup_name"
      },
      "workgroup_name": "sample workgroup_name"
    }
  ],
  "status_reason": "sample status_reason"
}