Profiles
Basic Profile Operations
Last updated
Basic Profile Operations
Last updated
/prod/v0/profiles/
curl -L \
--url '/prod/v0/profiles/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'[
{
"id": 1,
"template_id": 1,
"tags": [
{
"id": 1,
"name": "text",
"description": "text"
}
],
"specification": "text",
"template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"snapshots": [
{
"id": 1,
"status": "text",
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}
]
}
]/prod/v0/profiles/
curl -L \
--request POST \
--url '/prod/v0/profiles/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"id": 1,
"template_id": 1,
"tags": [
{
"id": 1,
"name": "text",
"description": "text"
}
],
"specification": "text",
"template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"snapshots": [
{
"id": 1,
"status": "text",
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}
]
}'{
"id": 1,
"template_id": 1,
"tags": [
{
"id": 1,
"name": "text",
"description": "text"
}
],
"specification": "text",
"template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"snapshots": [
{
"id": 1,
"status": "text",
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}
]
}/prod/v0/profiles/{id}//
A unique integer value identifying this profile.
curl -L \
--url '/prod/v0/profiles/{id}/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'{
"id": 1,
"template_id": 1,
"tags": [
{
"id": 1,
"name": "text",
"description": "text"
}
],
"specification": "text",
"template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"snapshots": [
{
"id": 1,
"status": "text",
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}
]
}/prod/v0/profiles/{id}//
A unique integer value identifying this profile.
curl -L \
--request PUT \
--url '/prod/v0/profiles/{id}/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"id": 1,
"template_id": 1,
"tags": [
{
"id": 1,
"name": "text",
"description": "text"
}
],
"specification": "text",
"template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"snapshots": [
{
"id": 1,
"status": "text",
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}
]
}'{
"id": 1,
"template_id": 1,
"tags": [
{
"id": 1,
"name": "text",
"description": "text"
}
],
"specification": "text",
"template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"snapshots": [
{
"id": 1,
"status": "text",
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}
]
}/prod/v0/profiles/{id}//
A unique integer value identifying this profile.
curl -L \
--request PATCH \
--url '/prod/v0/profiles/{id}/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"id": 1,
"template_id": 1,
"tags": [
{
"id": 1,
"name": "text",
"description": "text"
}
],
"specification": "text",
"template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"snapshots": [
{
"id": 1,
"status": "text",
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}
]
}'{
"id": 1,
"template_id": 1,
"tags": [
{
"id": 1,
"name": "text",
"description": "text"
}
],
"specification": "text",
"template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"snapshots": [
{
"id": 1,
"status": "text",
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}
]
}/prod/v0/profiles/{id}//
A unique integer value identifying this profile.
curl -L \
--request DELETE \
--url '/prod/v0/profiles/{id}/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'No body
No response body
/prod/v0/snapshots/
curl -L \
--url '/prod/v0/snapshots/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'[
{
"id": 1,
"status": "text",
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}
]/prod/v0/snapshots/{id}//
A unique integer value identifying this snapshot.
curl -L \
--url '/prod/v0/snapshots/{id}/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'{
"id": 1,
"status": "text",
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}/prod/v0/profiles/{profile_id}/snapshots/
^\d+$curl -L \
--url '/prod/v0/profiles/{profile_id}/snapshots/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'[
{
"id": 1,
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}
]/prod/v0/profiles/{profile_id}/snapshots/
^\d+$curl -L \
--request POST \
--url '/prod/v0/profiles/{profile_id}/snapshots/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"id": 1,
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}'{
"id": 1,
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}/prod/v0/profiles/{profile_id}/snapshots/{snapshot_id}//
^\d+$curl -L \
--url '/prod/v0/profiles/{profile_id}/snapshots/{snapshot_id}/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'{
"id": 1,
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"id": 1,
"name": "text",
"specification": "text",
"source_entity_type": "text",
"description": "text",
"type": "text",
"enum_values": [
"text"
],
"enum_many": true,
"rel_template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"field": {
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template_id": 1,
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
},
"status": "text",
"value": null,
"sources": [
"text"
]
}
],
"reports": [
{
"id": 1,
"profile_id": 1,
"outline_id": 1,
"outline": {
"id": 1,
"profile_id": 1,
"report_title": "text",
"section_titles": [
"text"
],
"outline": null,
"perspective": "text"
},
"report": null
}
]
}Get the latest snapshot health for a profile
/prod/v0/health/profile/{profile_id}/latest/
curl -L \
--url '/prod/v0/health/profile/{profile_id}/latest/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'No body
No response body
Attach a created field to a profile
/prod/v0/created-fields/{field_id}/profile/
^\d+$curl -L \
--request POST \
--url '/prod/v0/created-fields/{field_id}/profile/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"profile_id": 1
}'No body
No response body