Skip to main content
POST
sms.business-profiles.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
limit
number

Maximum results, 1–20; default 10.

Required range: x >= 1
cursor
string

Opaque cursor from a previous page.

Required string length: 1 - 4096
entityType
enum<string>

Business ownership category.

Available options:
private,
public,
non_profit,
government,
individual
industry
string

Business industry, such as technology or professional.

Required string length: 1 - 64
Pattern: ^[a-z_]+$

Response

The result

results
object[]
required

Your business profiles; no contact or tax details.

nextCursor
string

Opaque cursor for the next page.