Skip to main content
GET
/
2.0
/
channel
Get channels
curl --request GET \
  --url https://api.shipbob.com/2.0/channel \
  --header 'Authorization: Bearer <token>'
[
  {
    "application_name": "SMA",
    "id": 128944,
    "name": "Privileged Access Token Wednesday, July 9, 2025",
    "scopes": [
      "pricing_read",
      "fulfillments_write",
      "returns_read",
      "receiving_read",
      "fulfillments_read",
      "returns_write",
      "locations_write",
      "channels_read",
      "webhooks_write",
      "locations_read",
      "orders_write",
      "webhooks_read",
      "inventory_read",
      "billing_read",
      "receiving_write",
      "inventory_write",
      "orders_read",
      "products_read",
      "products_write"
    ]
  },
  {
    "application_name": "ShipBob",
    "id": 128943,
    "name": "ShipBob Default",
    "scopes": [
      "pricing_read",
      "returns_read",
      "receiving_read",
      "fulfillments_read",
      "channels_read",
      "locations_read",
      "webhooks_read",
      "inventory_read",
      "billing_read",
      "orders_read",
      "products_read"
    ]
  }
]
Use the Channel Resource to list channels which you have access to. You will use this channelId for subsequent API calls made to ShipBob endpoints. A channel is a specific installation of an application built by a vendor on top of our API e.g. John’s Custom Integration #133432. All write endpoints require a channel to be passed in the header to complete the request. The channel is used to identify where the data originally came from. Applications that are granted multi-channel permissions will be able to read data from all channels that belong to a user. However, multi-channel applications will only be able to write on behalf of their own channel.

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Response

Success

​
application_name
string | null

Name of the application that owns the channel

Example:

"Api"

​
id
integer

Unique id of the channel

​
name
string | null

Name of the channel

​
scopes
string[] | null

Array of permissions granted for the channel

Example:
[
  "channels_read",
  "orders_read",
  "orders_write"
]