Skip to main content
GET
Get process

Authorizations

Authorization
string
header
default:PHONEFARM_API_KEY
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

process_id
string<uuid>
required

Response

Current process state.

process_id
string<uuid>
required
process_type
string
required
platform
enum<string>
required
Available options:
tiktok,
instagram
status
enum<string>
required
Available options:
queued,
executing,
retrying,
completed,
failed_terminal,
cancelled
target
object
required
requested_by
object
required
result
object
required
timestamps
object
required
linked_ids
object
required
partial_progress
object
required
request_id
string | null
callback
object | null
error
object | null