EQTY LabDocs

Get policy

Retrieve a specific policy by ID, including its controls

gethttps://localhost:10001/api/v1/organizations/{orgId}/policies/{policyId}
bash
curl --request GET \
  --url 'https://localhost:10001/api/v1/organizations/{orgId}/policies/{policyId}' \
  --header 'Authorization: Bearer <token>'
javascript
const response = await fetch("https://localhost:10001/api/v1/organizations/{orgId}/policies/{policyId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();
typescript
interface Policy {
  cid?: string;
  controls?: Record<string, unknown>[];
  createdAt?: string;
  description?: string;
  iconUrl?: string;
  id?: number;
  name?: string;
  organizationId?: number;
  slug?: string;
  type?: Record<string, unknown>;
  updatedAt?: string;
  version?: string;
}

const response = await fetch("https://localhost:10001/api/v1/organizations/{orgId}/policies/{policyId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: Policy = await response.json();
python
import requests

response = requests.get(
    "https://localhost:10001/api/v1/organizations/{orgId}/policies/{policyId}",
    headers={
        "Authorization": "Bearer <token>",
    },
)
response.raise_for_status()
print(response.json())
go
package main

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

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://localhost:10001/api/v1/organizations/{orgId}/policies/{policyId}", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://localhost:10001/api/v1/organizations/{orgId}/policies/{policyId}"))
            .header("Authorization", "Bearer <token>")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using System.Net.Http.Headers;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:10001/api/v1/organizations/{orgId}/policies/{policyId}");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://localhost:10001/api/v1/organizations/{orgId}/policies/{policyId}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
    ],
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://localhost:10001/api/v1/organizations/{orgId}/policies/{policyId}")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest, tokio (features "full")

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .get("https://localhost:10001/api/v1/organizations/{orgId}/policies/{policyId}")
        .header("Authorization", "Bearer <token>")
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Authorizations

  • BearerAuth · API key in header "Authorization" — Type "Bearer" followed by a space and JWT token.

Parameters

Path parameters

NameTypeDescription
orgId
required
string

Organization ID or UUID (urn:uuid optional)

policyId
required
string

Policy ID, slug:my-policy@1.2.0, or urn:cid:bafy...

Responses

200Policy with controls

application/json
  • cidstringread-only

    Assigned by the Integrity Service at creation

  • controlscore.Control[]

    Present on read, ignored on update

    Show properties

    Array of core.Control

    • cidstringread-only

      Assigned by the Integrity Service at creation

    • citationscore.Citation[]

      Up to 20

      Show properties

      Array of core.Citation

      • titlestring

        Up to 255 characters; trimmed

      • urlstring

        An absolute http or https URL with a hostname, up to 2048 bytes; trimmed

    • controlCodestring

      Alphanumeric, . and -; upper-cased

    • createdAtstring<date-time>read-only
    • descriptionstring
    • idintegerread-only
    • policyIdintegerread-only

      Assigned from the parent policy

    • titlestring
    • updatedAtstring<date-time>read-only
  • createdAtstring<date-time>read-only
  • descriptionstring
  • iconUrlstring
  • idintegerread-only
  • namestring
  • organizationIdintegerread-only

    Taken from the path on create

  • slugstringread-only

    Derived from name

  • typeobject

    See PolicyType for values

    Show properties

    object — See PolicyType for values

  • updatedAtstring<date-time>read-only
  • versionstring
Examplejson
{
  "cid": "string",
  "controls": [
    {
      "citations": [
        {
          "title": "string",
          "url": "string"
        }
      ],
      "controlCode": "string",
      "description": "string",
      "title": "string"
    }
  ],
  "createdAt": "2025-01-01T00:00:00Z",
  "description": "string",
  "iconUrl": "string",
  "id": 0,
  "name": "string",
  "organizationId": 0,
  "slug": "string",
  "type": {},
  "updatedAt": "2025-01-01T00:00:00Z",
  "version": "string"
}

400Bad request - Invalid organization ID or policy ID

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

401Unauthorized - Authentication required

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

403Forbidden - No organization access

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

404Policy not found

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}

500Internal server error

application/json
  • errorstring
Examplejson
{
  "error": "Invalid request body"
}