Skip to content
Docs menu

Copy the text

Your browser did not allow copying. The text below is selected: press Ctrl+C, or ⌘C on a Mac.

List devices

Devices that get notifications about conversions.

GEThttps://api.switchfile.io/v1/account/devices

Needs an API key: Authorization: Bearer YOUR_API_KEY. See Authentication.

Example

curl "https://api.switchfile.io/v1/account/devices" \
  -H "Authorization: Bearer $SWITCHFILE_API_KEY"

Responses

  • 200OK
    • dataDevice[]required
    • data[].created_atstringrequired

      ISO 8601 timestamp

    • data[].environmentstringrequired

      one of "production", "sandbox"

    • data[].idstring (uuid)required
    • data[].live_activity_startbooleanrequired

      A push-to-start token is registered

    • data[].localestringrequired
    • data[].notify_failedbooleanrequired
    • data[].notify_finishedbooleanrequired
    • data[].show_file_namesbooleanrequired
    • data[].updated_atstringrequired

      ISO 8601 timestamp

    200 application/json
    {
      "data": [
        {
          "id": "b3e1f2a4-5c6d-4e7f-8a9b-0c1d2e3f4a5b",
          "environment": "production",
          "locale": "de",
          "notify_finished": true,
          "notify_failed": true,
          "show_file_names": false,
          "live_activity_start": false,
          "created_at": "2026-11-06T18:00:00+00:00",
          "updated_at": "2026-11-06T18:00:00+00:00"
        }
      ]
    }
  • 401The API key is missing or not valid
    401 application/problem+json
    {
      "type": "https://switchfile.io/docs/api/v1#errors-unauthenticated",
      "title": "Unauthenticated",
      "status": 401,
      "code": "UNAUTHENTICATED",
      "detail": "Missing or invalid API key."
    }
  • 403Not available with a service key or a connected app
    403 application/problem+json
    {
      "type": "https://switchfile.io/docs/api/v1#errors-not-available",
      "title": "Not available",
      "status": 403,
      "code": "NOT_AVAILABLE",
      "detail": "This endpoint is only available with your own API key or the switchfile app."
    }
  • 404Does not exist for this account
    404 application/problem+json
    {
      "type": "https://switchfile.io/docs/api/v1#errors-not-found",
      "title": "Not found",
      "status": 404,
      "code": "NOT_FOUND",
      "detail": "Not found."
    }
  • 422Invalid data. errors names the fields
    422 application/problem+json
    {
      "type": "https://switchfile.io/docs/api/v1#errors-invalid-data",
      "title": "Invalid data",
      "status": 422,
      "code": "INVALID_DATA",
      "detail": "The request contains invalid data.",
      "errors": {
        "to": [
          "Expected string"
        ]
      }
    }
  • 429Too many requests or a daily quota is used up. See Retry-After
    429 application/problem+json
    {
      "type": "https://switchfile.io/docs/api/v1#errors-rate-limit-exceeded",
      "title": "Rate limit exceeded",
      "status": 429,
      "code": "RATE_LIMIT_EXCEEDED",
      "detail": "Too many requests. Try again in 12 seconds."
    }

Error bodies and codes are explained in Errors.