get/parties
List parties Scope: parties:read
List your parties (customers, consignees, agents, carriers). Filter by q, role, status; paginate with page/limit.
Requires the parties:read scope and the plan's apiRead feature.
Parameters
| Name | In | Required | Type |
|---|---|---|---|
| q | query | No | string |
| role | query | No | CUSTOMER, SHIPPER, CONSIGNEE, NOTIFY, AGENT, CARRIER, TRUCKER, BROKER, WAREHOUSE, OTHER |
| groupId | query | No | string |
| status | query | No | ACTIVE, ARCHIVED |
| linked | query | No | true, false |
| page | query | No | integer |
| limit | query | No | integer |