Get operation

curl --request GET \
  --url https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "operation": {
    "cancellable": true,
    "createdAt": "2026-01-01T00:00:00.000Z",
    "operationId": "<string>",
    "projectId": "<string>",
    "resourceType": "<string>",
    "state": "pending",
    "type": "resource.provision",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "detail": {},
    "endedAt": "2026-01-01T00:00:00.000Z",
    "error": {
      "code": "<string>",
      "detail": "<string>"
    },
    "reason": "charge_refused",
    "resourceId": "<string>",
    "startedAt": "2026-01-01T00:00:00.000Z"
  },
  "resource": {
    "abilities": [
      "<string>"
    ],
    "createdAt": "2026-01-01T00:00:00.000Z",
    "detail": {},
    "projectId": "<string>",
    "resourceId": "<string>",
    "state": "unallocated",
    "type": "<string>",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "retiredAt": "2026-01-01T00:00:00.000Z"
  }
}

{
  "code": "NOT_AUTHENTICATED",
  "status": 401,
  "title": "Not Authenticated",
  "type": "https://photon.codes/docs/problems/not-authenticated"
}

{
  "code": "FORBIDDEN",
  "status": 403,
  "title": "Forbidden",
  "type": "https://photon.codes/docs/problems/forbidden"
}

{
  "code": "OPERATION_NOT_FOUND",
  "status": 404,
  "title": "Operation Not Found",
  "type": "https://photon.codes/docs/problems/operation-not-found"
}

{
  "code": "VALIDATION_FAILED",
  "issues": [
    {
      "code": "invalid_type",
      "location": "json",
      "message": "Expected a string.",
      "path": "/name"
    }
  ],
  "status": 422,
  "title": "Request Validation Failed",
  "type": "https://photon.codes/docs/problems/validation-failed"
}

{
  "code": "RATE_LIMITED",
  "status": 429,
  "title": "Too Many Requests",
  "type": "https://photon.codes/docs/problems/rate-limited"
}

{
  "code": "INTERNAL_ERROR",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://photon.codes/docs/problems/internal-error"
}

{
  "code": "UPSTREAM_FAILURE",
  "status": 502,
  "title": "Upstream Service Failure",
  "type": "https://photon.codes/docs/problems/upstream-failure"
}

{
  "code": "UPSTREAM_UNAVAILABLE",
  "status": 503,
  "title": "Upstream Service Unavailable",
  "type": "https://photon.codes/docs/problems/upstream-unavailable"
}

{
  "code": "REQUEST_TIMEOUT",
  "status": 504,
  "title": "Request Timeout",
  "type": "https://photon.codes/docs/problems/request-timeout"
}

Operations

Get operation

Reads one operation using the same operation representation as creation and list. The API includes detail.setupUrl only with platforms:write for this project. This is the polling endpoint every asynchronous request here points its Location at, and it resolves from the moment that request is accepted — an operation is committed before its work is dispatched, so there is no window in which the URL 404s. Poll until state is one of succeeded, failed or cancelled, pacing from the Retry-After the accepting response returned. While an email domain waits for DNS, detail always contains the manual records and may additionally contain automaticSetup with a signed provider URL to open separately. Once the operation has produced a resource, the response carries that resource too, so the poll that finishes is also the one that tells you what you got. succeeded means the work is done; billing runs behind it and is not something the caller waits on. Operations are never purged, so a 404 means the id was never this project’s. Requires the platforms:read permission bound to the project resource in the path.

GET

projects

{id}

platforms

operations

{operationId}

Get operation

curl --request GET \
  --url https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.photon.codes/v1/projects/{id}/platforms/operations/{operationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "operation": {
    "cancellable": true,
    "createdAt": "2026-01-01T00:00:00.000Z",
    "operationId": "<string>",
    "projectId": "<string>",
    "resourceType": "<string>",
    "state": "pending",
    "type": "resource.provision",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "detail": {},
    "endedAt": "2026-01-01T00:00:00.000Z",
    "error": {
      "code": "<string>",
      "detail": "<string>"
    },
    "reason": "charge_refused",
    "resourceId": "<string>",
    "startedAt": "2026-01-01T00:00:00.000Z"
  },
  "resource": {
    "abilities": [
      "<string>"
    ],
    "createdAt": "2026-01-01T00:00:00.000Z",
    "detail": {},
    "projectId": "<string>",
    "resourceId": "<string>",
    "state": "unallocated",
    "type": "<string>",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "retiredAt": "2026-01-01T00:00:00.000Z"
  }
}

{
  "code": "NOT_AUTHENTICATED",
  "status": 401,
  "title": "Not Authenticated",
  "type": "https://photon.codes/docs/problems/not-authenticated"
}

{
  "code": "FORBIDDEN",
  "status": 403,
  "title": "Forbidden",
  "type": "https://photon.codes/docs/problems/forbidden"
}

{
  "code": "OPERATION_NOT_FOUND",
  "status": 404,
  "title": "Operation Not Found",
  "type": "https://photon.codes/docs/problems/operation-not-found"
}

{
  "code": "VALIDATION_FAILED",
  "issues": [
    {
      "code": "invalid_type",
      "location": "json",
      "message": "Expected a string.",
      "path": "/name"
    }
  ],
  "status": 422,
  "title": "Request Validation Failed",
  "type": "https://photon.codes/docs/problems/validation-failed"
}

{
  "code": "RATE_LIMITED",
  "status": 429,
  "title": "Too Many Requests",
  "type": "https://photon.codes/docs/problems/rate-limited"
}

{
  "code": "INTERNAL_ERROR",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://photon.codes/docs/problems/internal-error"
}

{
  "code": "UPSTREAM_FAILURE",
  "status": 502,
  "title": "Upstream Service Failure",
  "type": "https://photon.codes/docs/problems/upstream-failure"
}

{
  "code": "UPSTREAM_UNAVAILABLE",
  "status": 503,
  "title": "Upstream Service Unavailable",
  "type": "https://photon.codes/docs/problems/upstream-unavailable"
}

{
  "code": "REQUEST_TIMEOUT",
  "status": 504,
  "title": "Request Timeout",
  "type": "https://photon.codes/docs/problems/request-timeout"
}

Authorizations

Authorization

string

header

required

Account Service Key, prefixed with pho_ask_, sent as Authorization: Bearer <key>. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.

Path Parameters

string

required

operationId

string

required

Response

The operation, and the resource it produced once one exists. Retry-After is supplied for pending/running campaign and Telegram operations and omitted once terminal.

operation

object

required

Show child attributes

resource

object

Show child attributes

⌘I

Get started

Problems

Endpoints

Event Delivery WebSocket

Event schemas

Get operation

Authorizations

Path Parameters

Response