Skip to main content
GET
List async change requests

Authorizations

Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key. You can find your API key on the Hologram Dashboard under Account Settings.

Query Parameters

ids
string

Comma-separated list of request IDs to fetch

parent_id
integer

Filter by parent request ID

orgid
integer

Filter by organization ID

userid
integer

Filter by user ID

request_type
enum<string>

Filter by request type

Available options:
plan_change,
euicc_audit,
sim_configuration_update,
sim_state_pause,
sim_state_unpause,
sim_state_activation
reference_type
enum<string>

Filter by the type of object being changed

Available options:
device,
link,
simcard,
sim_configuration
reference_id
integer

Filter by the ID of the object being changed

deviceids
string

Comma-separated list of device IDs; returns async records referencing those devices (reference_type=device) or their cellular links (reference_type=link). Resolves link IDs via CellularLinks before querying. Can be combined with other filters (e.g. orgid, states, reference_type); all filters are ANDed together.

states[]
enum<string>[]

Filter by one or more states (repeat parameter for multiple values)

Available options:
initialized,
in_progress,
complete,
complete_with_errors,
partially_complete,
error,
canceled,
complete_after_cancel
start_after
string

Return requests started after this time (Unix timestamp or datetime string)

start_before
string

Return requests started before this time (Unix timestamp or datetime string)

startafter
integer

Return results with ID less than this value (cursor-based pagination, ordered by ID descending)

limit
integer

Maximum number of results to return (default 25, max 1000)

Required range: x <= 1000
Example:

25

Response

OK

success
boolean

Indicates whether the request was successful.

Example:

true

limit
integer
size
integer
continues
boolean
lastid
integer

ID of the last record returned, for cursor-based pagination

data
object[]