---
title: "Get the current list of all available capacity provider account infos."
method: GET
path: "/api/v4/capacityprovideraccounts"
tags: ["Capacity Provider Account Management"]
---

# Get the current list of all available capacity provider account infos.

`GET /api/v4/capacityprovideraccounts`

## Request

- Base URL: `https://na12.api.project44.com`
- URL: `https://na12.api.project44.com/api/v4/capacityprovideraccounts`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/api/v4/oauth2/token`
- TypeScript: <https://skmtc.dev/project44/apis/project44-rest-api/docs/api/v4/capacityprovideraccounts/get.ts> (a function with typed inputs; its response is checked against the schema)

Each capacity provider account infos object returned in the response includes a unique ID that can be used as a reference in other APIs. It's important to note that we no longer send decrypted credentials through this service. A maximum of 1000 objects may be returned from a single API call.

## Query parameters

- `accountGroupCode` string

## Response `200`

OK

- CapacityProviderAccountInfosCollection: A collection of one or more account definitions for a capacity provider.
  - `accounts` CapacityProviderAccountInfos[]: List of capacity provider accounts, possible across multiple account groups.
    - `accounts` CapacityProviderAccountInfo[]: Only one account for each of the capacity provider's account definitions may be provided. On update, accounts in this list may reference ids of existing accounts or may be completely new accounts without ids if replacement is desired. Use the "Capacity Provider Metadata" API to get account definition information for a capacity provider. This API will indicate all fields that must be specified on CapacityProviderAccountInfo for each account type for a given capacity provider.
      - `accountDefinitionIdentifier` string: Capacity provider account definition identifier is used to distinguish capacity provider accounts when a specific capacity provider has more then one account definition for different services. Use the "Capacity Provider Metadata" API to get account definition information for a capacity provider.
      - `accountFlag1` boolean: A boolean flag related to the your account with the capacity provider, defined by the applicable capacity provider account definition (e.g., for UPGF, this is 'enable density-based rating').
      - `accountNumber1` string: The first account number with the capacity provider if this capacity provider account type has account numbers. This may be a bill-to account number, a shipper account number, a consignee account number, or some other account number.
      - `accountNumber2` string: The second account number with the capacity provider if this capacity provider account type has account numbers. This may be a bill-to account number, a shipper account number, a consignee account number, or some other account number.
      - `billToLocationId` string: The project44-generated id of the bill-to location. Locations can be created, updated, and retrieved through the location management API.
      - `credential1` string: The first password, authentication key, or other credentials with the capacity provider, if this capacity provider account type has one of these. This field will not appear in any response object.
      - `credential2` string: The second password, authentication key, or other credentials with the capacity provider, if this capacity provider account type has one of these.
      - `credential3` string: The third password, authentication key, or other credentials with the capacity provider, if this capacity provider account type has one of these.
      - `directionCode` 'SHIPPER' | 'CONSIGNEE' | 'THIRD_PARTY': The direction or shipment terms of the your account with the capacity provider -- the party responsible for the shipment.
      - `enableDirectionOverride` boolean: Whether or not direction for this capacity provider account can be overridden in an API request. The direction for some capacity provider accounts should never be overridden, while others need to be changed depending on the origin and destination of a shipment or other factors. Whether this override should be enabled depends primarily on the capacity provider. (default: 'false')
      - `enablePaymentTermsOverride` boolean: Whether or not payment terms for this capacity provider account can be overridden in an API request. The payment terms for some capacity provider accounts should never be overridden, while others need to be changed depending on the origin and destination of a shipment or other factors. Whether this override is enabled depends primarily on the capacity provider. (default: 'false')
      - `id` integer: The project44-generated id of the capacity provider account. This id may not be provided when creating a capacity provider account, but it is required when updating one.
      - `oAuth2LoginUrl` string
      - `oAuth2SignupUrl` string
      - `paymentTermsCode` 'PREPAID' | 'COLLECT' | 'THIRD_PARTY': The payment terms of the customer's account with the capacity provider -- the party responsible for payment.
      - `username1` string: The username of the account, if this capacity provider account type has a username.
    - `capacityProviderIdentifier` CapacityProviderIdentifier: A capacity provider identifier object.
      - `type` 'SCAC' | 'DOT_NUMBER' | 'MC_NUMBER' | 'P44_EU' | 'SYSTEM' | 'P44_GLOBAL' | 'VAT': Capacity provider identifier type.
      - `value` string: Capacity provider identifier value.
    - `code` string: The code identifier for the account set. This must be unique to the capacity provider account group this account set resides in.
    - `group` CapacityProviderAccountGroupInfo: The details necessary to get or instantiate a new capacity provider group.
      - `code` string: The unique, user-provided code used to identify this account group. Typically, an account group will correspond to a single customer or a single customer location. Account group codes are provided in shipment lifecycle APIs to identify a particular account. This field may be provided when creating an account group but is not required when creating or updating a set of capacity provider accounts in the capacity provider account management API.
      - `id` integer: The project44-generated id of the capacity provider account group. This id may not be provided when creating a capacity provider account group, but it is required when updating one or when creating or updating a capacity provider account set.
      - `name` string: The user-provided name to be assigned to this group. This field may be provided when creating an account group but is not required when creating or updating a set of capacity provider accounts in the capacity provider account management API.
    - `id` integer: The project44-generated id of the capacity provider account set. This id may not be provided when creating a capacity provider account set, but it is required when updating one.

## Other responses

- `400`: Invalid request
- `401`: Invalid or missing credentials
- `403`: User not authorized to perform this operation

---

[API](https://skmtc.dev/project44/apis/project44-rest-api.md) - [All operations](https://skmtc.dev/project44/apis/project44-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/project44/apis/project44-rest-api/revisions/cdf9675e2294?raw)