List

get
https://api.wafeq.com/v1/zatca/devices/

Endpoint for retrieving a list of Devices.

Query Params
string

The search term, based on fields:

  • common_name - The common name of the device (contains, case-insensitive).
integer

A page number within the paginated result set.

integer

Number of results to return per page.

Headers
string

If the account is under a Group VAT, then it is required to be the TIN of the instance under the Group VAT. Otherwise it is optional and can be used as a branch name

string

The unique identifier of the connected account you're operating on behalf of.

Connected accounts should be used only for Platforms and White Label integrations that onboard customers and report documents on their behalf. Omit the X-ZATCA-Connected-Account-Id header when registering devices or reporting documents for your own organization. See the Platforms and White Label guide.

stringrequired

The zatca environment to use, available options are ['production', 'simulation']

Response