Get a farm profile

Fetch a single farm profile by its profile_id, including its phone status and email.

Authentication

X-API-Keystring
API Key authentication via header

Path parameters

profile_idstringRequired

Response

Successful Response
profile_idstring
Unique profile identifier.
profile_namestring
Internal display name for the profile.
created_atinteger
Profile creation time as a Unix epoch in milliseconds.
tiktok_usernamestring or null
The TikTok handle linked to this profile.
phone_idstring or null

Cloud-phone identifier hosting this profile.

statusstring or null

Lifecycle status of the underlying farm phone. Common values: awaiting_signup, ready, failed, deactivated.

platformslist of strings or null

Platforms provisioned on this phone (e.g. tiktok, instagram).

accountslist of maps from strings to any or null

List of platform accounts on this phone, each with platform and username.

phone_numberstring or null
Rented SMS number associated with this phone.
phone_number_ends_atstring or null
Expiration timestamp of the rented phone number rental.

Errors

404
Not Found Error
422
Unprocessable Entity Error