POST
/
channel:search
curl --request POST \
  --url https://api.shipbob.com/experimental/channel:search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "cursor": "string",
  "records_per_page": 0,
  "search_filters": {
    "channel_ids": [
      0
    ],
    "channel_names": [
      "string"
    ]
  }
}'
{
  "items": [
    {
      "application_name": "string",
      "id": 0,
      "name": "string",
      "scopes": [
        "string"
      ]
    }
  ],
  "next": "string",
  "prev": "string",
  "total_records": 0
}

Authorizations

Authorization
string
header
required

Provide your personal access token in the format 'Bearer {your_personal_access_token}'

Body

application/json

Channel search request body

cursor
string | null

Next/Previous Cursor

records_per_page
integer

Records Per Page

search_filters
object

Search filters

Response

200
application/json
Success

GChannel search response

items
object[] | null

List of channels

Channel basic information

next
string | null

Next page cursor

prev
string | null

Previous page cursor

total_records
integer

Total records on current page

Was this page helpful?