Skip to main content
GET
/
api
/
v1
/
accounts
List accounts
curl --request GET \
  --url https://shelfforce.ai/api/v1/accounts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "brand",
      "status": "active",
      "createdAt": "2023-11-07T05:31:56Z",
      "contactName": "<string>",
      "contactEmail": "<string>",
      "contactPhone": "<string>",
      "website": "<string>",
      "notes": "<string>",
      "logoUrl": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "cursor": "<string>",
    "hasMore": true
  }
}

Authorizations

Authorization
string
header
required

API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...

Query Parameters

type
enum<string>

Filter by account type

Available options:
brand,
supplier,
distributor,
manufacturer,
retailer,
partner

Search by name

cursor
string

Pagination cursor

limit
integer
default:50

Max results

Required range: x <= 100

Response

Paginated list of accounts.

data
object[]
pagination
object

Cursor-based pagination metadata.