GEThttps://core-api.heysadie.ai/phone-numbers
limit offset search success data phoneNumbers id phoneNumber country monthlySubscriptionCost createdAt updatedAt assistantName total metadata timestamp version path error code message details fieldList phone numbers
Try it in the API ExplorerExample request
Terminal
curl "https://core-api.heysadie.ai/phone-numbers?limit=10&offset=0" \
-H "Authorization: ApiKey YOUR_API_KEY"Authentication
Authenticate with an API key in the Authorization header using the ApiKey scheme — see Authentication for how keys work and where to get them.
AuthorizationstringrequiredAPI key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.
X-Tenant-Idstring (uuid)optionalRequired when authenticating with an organization key — selects the tenant the request acts on. Omit with tenant keys.
Request
Query parameters
limitstringoptionalMax number of records to return
offsetstringoptionalNumber of records to skip
searchstringoptionalSearch phone numbers by phone number or country (case-insensitive partial match)
Responses
200
successbooleanrequireddataobjectoptionalShow 2 child properties
phoneNumbersobject[]requiredList of tenant-owned phone numbers
Show 7 item properties
idstringrequiredphoneNumberstringrequiredcountrystringrequiredmonthlySubscriptionCoststring | nullrequiredcreatedAtstring (date-time) | string (date) | number | nullrequiredupdatedAtstring (date-time) | string (date) | number | nullrequiredassistantNamestring | nullrequiredtotalnumberrequiredTotal number of phone numbers found
metadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional400
successbooleanrequirederrorobjectoptionalShow 3 child properties
codeenumrequiredAllowed values:
"VALIDATION_ERROR"messagestringrequireddetailsobject[]optionalShow 2 item properties
fieldstringrequiredmessagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional401
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequiredAllowed values:
"UNAUTHORIZED"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional403
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequiredAllowed values:
"FORBIDDEN"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional404
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequiredAllowed values:
"RESOURCE_NOT_FOUND"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional500
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequiredAllowed values:
"INTERNAL_SERVER_ERROR"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional