Sign in

v3

latestOpenAPI 3.1.02026-08-0797185285.8 KB

Get Source

Get single source

get/sources/{id}

Path parameters

idstring required
Example:src_1EBBF4M7X1S06G1Y

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Response

Successful Response

idstring required
supplier_reference_idstring nullable required

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

display_namestring nullable required
descriptionstring nullable required
original_filenamestring nullable required
type'DOCUMENT' | 'WEBSITE' required
published_atstring date nullable required
is_publicboolean required

This field indicates Whether or not this source document will be public on the Registry once Credits are issued referencing it.

project_idstring nullable required

The ID of the project that the source is associated with.

Example response

{
  "id": "src_1EBBF4M7X1S06G1Y",
  "project_id": "prj_1CTWZQGKE1S0VAXA"
}