atteq API
  • Guides
  • Recipes
  • Cookbook
  • API Reference
Information
agents
    List AgentsgetCreate AgentpostDocument AttachmentsgetGet VersiongetEdit DraftpatchReplace Draft GraphputPublish VersionpostGet AgentgetDelete AgentdeleteCopy AgentpostGet DraftgetGet Agent MapgetPending ChangesgetList PlacementsgetRestore VersionpostList VersionsgetGet Mapget
voice_agent
    Open Browser CallpostEnd Browser CalldeleteGet Agent Test LinkgetGet Bridge CeilinggetSet Bridge Ceilingpatch
ai_profiles
    Get Ai Profile CapabilitiesgetList Live SettingsgetCreate Live SettingspostDelete Live SettingsdeleteUpdate Live SettingspatchList Llm SettingsgetCreate Llm SettingspostDelete Llm SettingsdeleteUpdate Llm SettingspatchList ProfilesgetCreate ProfilepostGet ProfilegetDelete ProfiledeleteUpdate ProfilepatchCopy ProfilepostSet Text SectionputSet Voice SectionputList Stt SettingsgetCreate Stt SettingspostDelete Stt SettingsdeleteUpdate Stt SettingspatchList Tts SettingsgetCreate Tts SettingspostDelete Tts SettingsdeleteUpdate Tts SettingspatchList Vad SettingsgetCreate Vad SettingspostDelete Vad SettingsdeleteUpdate Vad Settingspatch
analyst
    List Agent FindingsgetCall Back FindingpostDismiss FindingpostUndo Finding DismissaldeleteTeach FindingpostWatch FindingpostList Question ChartsgetList Tracked QuestionsgetCreate Tracked QuestionpostGet Question Search CostgetSearch For Tracked QuestionpostPropose Tracked QuestionpostDelete Tracked QuestiondeleteUpdate Tracked QuestionpatchGet Reading SwitchgetSet Reading SwitchputGet Agent Summaryget
analytics
    List ChartsgetCreate ChartpostPreview ChartpostGet ChartgetDelete ChartdeleteUpdate ChartpatchRun ChartpostList DatasetsgetList BoardsgetCreate BoardpostGet TraversalgetGet BoardgetDelete BoarddeleteUpdate Boardpatch
authentication
    List InvitationsgetInvite MemberpostRevoke InvitationdeleteResend InvitationpostList MembersgetRemove MemberdeleteGet Member Conversation AccessgetSet Member Conversation AccesspatchSet Member FlagspatchSet Member RolepatchGet OrganizationgetUpdate OrganizationpatchGet Role FlagsgetSet Role Flagspatch
automations
    List AutomationsgetCreate AutomationpostGet AutomationgetDelete AutomationdeleteUpdate AutomationpatchSet Automation EnabledputGet Automation MapgetRun AutomationpostList Automation RunsgetGet Automation Runget
billable-metrics
    List MetricsgetUsage SummarygetGet Metricget
outbound_calls
    Place CallpostList CampaignsgetCreate CampaignpostGet CampaigngetDelete CampaigndeleteUpdate CampaignpatchActivate CampaignpostLink CollectionpostAdd ContactspostAdd Contacts From CollectionpostRemove Contacts From CollectionpostSet Campaign HoursputPreview Campaign HourspostPause CampaignpostGet Campaign SummarygetExclude ContactpostInclude Contactpost
channels
    List ChannelsgetCreate ChannelpostList Thread SubjectsgetClose Channel ThreadpostList Thread DecisionsgetGet Thread Contact FilegetHand Thread To AgentpostList Thread MailgetGet Prepared ReplygetAsk Again For Prepared ReplypostDiscard Prepared ReplypostSend Prepared ReplypostReply On Channel ThreadpostGet ChannelgetDelete ChanneldeleteUpdate ChannelpatchSend On ChannelpostList Channel ThreadsgetList RostergetCreate Roster EntrypostGet Own Roster EntrygetGet Roster EntrygetDelete Roster EntrydeleteUpdate Roster EntrypatchAdd Roster AddresspostChange Roster AddressputRemove Roster Addressdelete
custom-data
    List CollectionsgetCreate CollectionpostList Collection NamesgetGet CollectiongetDelete CollectiondeleteUpdate CollectionpatchAdd FieldpostDelete FielddeleteUpdate FieldpatchImport RecordspostPlan ImportpostPropose ImportpostGet ImportgetList RecordsgetCreate RecordpostBulk Delete RecordspostBulk Set FieldpostCount RecordsgetList Records Of ContactgetDelete Records Of ContactdeleteGet RecordgetDelete RecorddeleteUpdate Recordpatch
connections
    List ConnectionsgetCreate ConnectionpostCreate Forwarded AddresspostCreate Mail ServerpostDiscover Mail ServerpostAuthorize Microsoft MailboxpostList ProvidersgetGet ConnectiongetDelete ConnectiondeleteUpdate ConnectionpatchGet Forwarded AddressgetCheck Forwarded AddresspostList Person GrantsgetSet Person GrantputRemove Person GrantdeleteGet Mail ServergetUpdate Mail ServerpatchList Mail Server FoldersgetEnter Mail Server PasswordputChange Mail Server ServersputTest Mail Server AgainpostGet Microsoft MailboxgetUpdate Microsoft MailboxpatchList Microsoft Mailbox FoldersgetConsent To Microsoft Mailbox WritespostWithdraw Microsoft Mailbox Writesdelete
custom-tools
    List Custom ToolsgetCreate Custom ToolpostGet Custom ToolgetDelete Custom TooldeleteGet Custom Tool DraftgetEdit Custom Tool DraftpatchPublish Custom ToolpostRestore Custom Tool VersionpostTry Custom ToolpostList Custom Tool Versionsget
rag
    List DocumentsgetUpload DocumentpostSearch DocumentspostGet DocumentgetDelete DocumentdeleteDownload DocumentgetReingest Documentpost
flows
    List FlowsgetCreate FlowpostGet FlowgetDelete FlowdeleteRename FlowpatchAdd Flow EdgepostDelete Flow EdgedeleteSet Entry SteppatchAdd SteppostDelete StepdeleteUpdate SteppatchTest FlowpostList Flow Testsget
dynamic_context
    Create GraphpostGet GraphgetDelete GraphdeleteAdd EdgepostDelete EdgedeleteAdd NodepostDelete NodedeleteUpdate NodepatchSet Rootput
inbox
    Get Inbox Open CountgetSet Inbox PreferencespatchGet Inbox RailgetCreate Inbox ViewpostDelete Inbox ViewdeleteUpdate Inbox Viewpatch
handoff
    Assign Threadpost
interactions
    List InteractionsgetCount InteractionsgetGet InteractiongetSet Conversation LabelspostGet TracegetGet TranscriptgetList LabelsgetCreate LabelpostDelete LabeldeleteUpdate Labelpatch
legal
    Agree To Processing AgreementpostAgree To TermspostLegal BoxesgetList Legal DocumentsgetRead Legal DocumentgetList Legal VersionsgetRead Legal VersiongetDownload Legal VersiongetOrganization Legal HistorygetOwn Legal HistorygetObject To SubprocessorspostWithdraw ObjectionpostLegal Pendingget
not-a-tool
    Agree To Processing AgreementpostAgree To TermspostObject To SubprocessorspostWithdraw Objectionpost
memory
    List MemoriesgetList Memory LinesgetCreate Memory LinepostDelete Memory LinedeleteUpdate Memory LinepatchList Memory PeoplegetGet Memory PersongetForget PersondeleteGet Memory SwitchgetSet Memory SwitchputWipe ContactdeleteGet Conversation MemorygetRecall MemoriespostGet MemorygetDelete MemorydeletePatch Memorypatch
notifications
    List InboxgetGet Unread CountgetMark ReadpostMark Unreaddelete
recipes
    List RecipesgetList Installed RecipesgetGet Installed RecipegetUninstall RecipedeleteSet Recipe EnabledputUpdate Recipe ParameterspatchUpdate RecipepostInstall Recipepost
data-retention
    Get RetentiongetSet Retentionpatch
text
    Open ConversationpostClose ConversationpostAnswer ConfirmationpostGet Sent FilegetSend MessagepostSet Modepatch
tools
    List ToolsgetCreate ToolpostList BuiltinsgetImport Mcp ServerpostImport OpenapipostPreview Openapi ImportpostSuggest Tool ExamplespostGet ToolgetDelete TooldeleteUpdate ToolpatchTest ToolpostList Tool Testsget
trunks
    List Transfer DirectorygetCreate Transfer Directory EntrypostGet Transfer Directory EntrygetDelete Transfer Directory EntrydeleteUpdate Transfer Directory EntrypatchList TrunksgetCreate TrunkpostGet TrunkgetDelete TrunkdeleteUpdate TrunkpatchList Forward Recordsget
Schemas
powered by Zudoku
attek API
attek API

legal


Agree To Processing Agreement

POST
/api/v1/legal/agreements/organization

Agree, as an owner, to the data processing agreement for your organization, stating you may bind it. Never while impersonating.

Agree To Processing Agreement › Request Body

`POST /legal/agreements/organization`: an owner agrees to the data processing agreement for the organization, stating they may bind it, in one box (rules 17-18, 21-22). `version` is the one the page showed: the version in force, or one published to take effect later.
OrganizationAgreementIn
language
​LegalLanguage · enum · required

The languages a version may be written in (values table): Spanish required, English optional, and the Spanish prevails (rule 4).

Enum values:
es
en
ticked
​boolean · required
version
​string · required

Agree To Processing Agreement › Responses

Successful Response

One entry of the proof, as its organization's owners and its person read it (rules 26, 28). Never changed once written.
LegalRecordOut
​required
id
​string · uuid · required
kind
​RecordKind · enum · required

What one entry of the proof records.

Enum values:
person_agreement
organization_agreement
objection
objection_withdrawn
own_agreement_marked
own_agreement_unmarked
​required
​required
​required
​required
​required
origin
​Origin · enum · required

Where an entry came from (rule 26): the dashboard or a key -- and, for a mark, staff from the directory (rule 23). before_legal is an agreement kept before this proof existed, carried over with what was kept then.

Enum values:
dashboard
key
staff
before_legal
​required
​required
​required
person_name
​string · required
​required
recorded_at
​string · date-time · required
​required
​required
​required
​AgreedVersionOut[] · required
​required
POST/api/v1/legal/agreements/organization
curl /api/v1/legal/agreements/organization \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "language": "es", "ticked": true, "version": "version" }'
Example Request Body
{ "language": "es", "ticked": true, "version": "version" }
json
Example Responses
{ "api_key_id": "00000000-0000-0000-0000-000000000000", "id": "00000000-0000-0000-0000-000000000000", "kind": "person_agreement", "language": "es", "network_address": "string", "objection_id": "00000000-0000-0000-0000-000000000000", "org_id": "00000000-0000-0000-0000-000000000000", "org_name": "string", "origin": "dashboard", "own_agreement": "string", "person_email": "string", "person_id": "00000000-0000-0000-0000-000000000000", "person_name": "person_name", "reason": "string", "recorded_at": "2024-08-25T15:00:00Z", "role": "owner", "subprocessors": [ "string" ], "user_agent": "string", "versions": [ { "document": "terms", "fingerprint": "fingerprint", "language": "es", "name": "name" } ], "words": "string" }
json
application/json

Agree To Terms

POST
/api/v1/legal/agreements/person

Agree, as yourself, to the Terms and the Privacy policy in force, together. Never while impersonating.

Agree To Terms › Request Body

`POST /legal/agreements/person`: a person agrees again to the Terms and the Privacy policy in force, together (rules 15-16). The versions are the ones the page showed, so what is kept is what was read; `ticked` is the box.
PersonAgreementIn
language
​LegalLanguage · enum · required

The languages a version may be written in (values table): Spanish required, English optional, and the Spanish prevails (rule 4).

Enum values:
es
en
privacy
​string · required
terms
​string · required
ticked
​boolean · required

Agree To Terms › Responses

Successful Response

One entry of the proof, as its organization's owners and its person read it (rules 26, 28). Never changed once written.
LegalRecordOut
​required
id
​string · uuid · required
kind
​RecordKind · enum · required

What one entry of the proof records.

Enum values:
person_agreement
organization_agreement
objection
objection_withdrawn
own_agreement_marked
own_agreement_unmarked
​required
​required
​required
​required
​required
origin
​Origin · enum · required

Where an entry came from (rule 26): the dashboard or a key -- and, for a mark, staff from the directory (rule 23). before_legal is an agreement kept before this proof existed, carried over with what was kept then.

Enum values:
dashboard
key
staff
before_legal
​required
​required
​required
person_name
​string · required
​required
recorded_at
​string · date-time · required
​required
​required
​required
​AgreedVersionOut[] · required
​required
POST/api/v1/legal/agreements/person
curl /api/v1/legal/agreements/person \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "language": "es", "privacy": "privacy", "terms": "terms", "ticked": true }'
Example Request Body
{ "language": "es", "privacy": "privacy", "terms": "terms", "ticked": true }
json
Example Responses
{ "api_key_id": "00000000-0000-0000-0000-000000000000", "id": "00000000-0000-0000-0000-000000000000", "kind": "person_agreement", "language": "es", "network_address": "string", "objection_id": "00000000-0000-0000-0000-000000000000", "org_id": "00000000-0000-0000-0000-000000000000", "org_name": "string", "origin": "dashboard", "own_agreement": "string", "person_email": "string", "person_id": "00000000-0000-0000-0000-000000000000", "person_name": "person_name", "reason": "string", "recorded_at": "2024-08-25T15:00:00Z", "role": "owner", "subprocessors": [ "string" ], "user_agent": "string", "versions": [ { "document": "terms", "fingerprint": "fingerprint", "language": "es", "name": "name" } ], "words": "string" }
json
application/json

Legal Boxes

GET
/api/v1/legal/boxes

The exact words of each box -- agreeing to the Terms and the Privacy policy, to the data processing agreement, objecting and withdrawing -- in each language. Changes nothing.

Legal Boxes › Responses

200

Successful Response

`GET /legal/boxes`: the exact words of each box, in each language, as the proof keeps them (rule 26). A screen shows these words and no others.
BoxesOut
​object · required
​object · required
​object · required
​object · required
GET/api/v1/legal/boxes
curl /api/v1/legal/boxes
Example Responses
{ "objection": { "key": "string" }, "organization": { "key": "string" }, "person": { "key": "string" }, "withdrawal": { "key": "string" } }
json
application/json

List Legal Documents

GET
/api/v1/legal/documents

List the platform's legal documents, each with its version in force and any published to take effect later. Readable without signing in. Changes nothing.

List Legal Documents › Responses

200

Successful Response

​LegalDocumentOut[]
One document: its address that always shows the version in force (rule 6), that version, and one published to take effect later (rule 5).
LegalDocumentOut
address
​string · required
​required
document
​LegalDocument · enum · required

The six legal documents the platform keeps (rule 1). Each value is also the last segment of the document's address, so it is spelled as a URL is.

Enum values:
terms
privacy
cookies
acceptable-use
processing-agreement
subprocessors
​required
GET/api/v1/legal/documents
curl /api/v1/legal/documents
Example Responses
[ { "address": "address", "coming": { "address": "address", "coming": true, "deadline_at": "2024-08-25T15:00:00Z", "document": "terms", "effective_at": "2024-08-25T15:00:00Z", "fingerprints": { "key": "string" }, "in_force": true, "languages": [ "es" ], "material": true, "name": "name", "objection_ends_at": "2024-08-25T15:00:00Z", "published_at": "2024-08-25T15:00:00Z" }, "document": "terms", "in_force": { "address": "address", "coming": true, "deadline_at": "2024-08-25T15:00:00Z", "document": "terms", "effective_at": "2024-08-25T15:00:00Z", "fingerprints": { "key": "string" }, "in_force": true, "languages": [ "es" ], "material": true, "name": "name", "objection_ends_at": "2024-08-25T15:00:00Z", "published_at": "2024-08-25T15:00:00Z" } } ]
json
application/json

Read Legal Document

GET
/api/v1/legal/documents/{document}/current

Read the version in force of a legal document, in language where it is written in it and in Spanish otherwise, saying which. Changes nothing.

Read Legal Document › path Parameters

document
​LegalDocument · enum · required

The six legal documents the platform keeps (rule 1). Each value is also the last segment of the document's address, so it is spelled as a URL is.

Enum values:
terms
privacy
cookies
acceptable-use
processing-agreement
subprocessors

Read Legal Document › query Parameters

language
​LegalLanguage · enum

The languages a version may be written in (values table): Spanish required, English optional, and the Spanish prevails (rule 4).

Enum values:
es
en
Default: es

Read Legal Document › Responses

Successful Response

A version's text in the language asked, or in Spanish where it has none, and which one it is (rule 8).
VersionTextOut
address
​string · required
coming
​boolean · required
​required
document
​LegalDocument · enum · required

The six legal documents the platform keeps (rule 1). Each value is also the last segment of the document's address, so it is spelled as a URL is.

Enum values:
terms
privacy
cookies
acceptable-use
processing-agreement
subprocessors
effective_at
​string · date-time · required
fell_back
​boolean · required
fingerprint
​string · required
​object · required
in_force
​boolean · required
language
​LegalLanguage · enum · required

The languages a version may be written in (values table): Spanish required, English optional, and the Spanish prevails (rule 4).

Enum values:
es
en
languages
​LegalLanguage[] · required
Enum values:
es
en
material
​boolean · required
name
​string · required
​required
published_at
​string · date-time · required
text
​string · required
GET/api/v1/legal/documents/{document}/current
curl /api/v1/legal/documents/:document/current
Example Responses
{ "address": "address", "coming": true, "deadline_at": "2024-08-25T15:00:00Z", "document": "terms", "effective_at": "2024-08-25T15:00:00Z", "fell_back": true, "fingerprint": "fingerprint", "fingerprints": { "key": "string" }, "in_force": true, "language": "es", "languages": [ "es" ], "material": true, "name": "name", "objection_ends_at": "2024-08-25T15:00:00Z", "published_at": "2024-08-25T15:00:00Z", "text": "text" }
json
application/json

List Legal Versions

GET
/api/v1/legal/documents/{document}/versions

List a legal document's published versions, newest first, with the moment each took effect. Readable without signing in. Changes nothing.

List Legal Versions › path Parameters

document
​LegalDocument · enum · required

The six legal documents the platform keeps (rule 1). Each value is also the last segment of the document's address, so it is spelled as a URL is.

Enum values:
terms
privacy
cookies
acceptable-use
processing-agreement
subprocessors

List Legal Versions › Responses

Successful Response

​VersionOut[]
One published version of a document, without its text (rules 2, 7, 10).
VersionOut
address
​string · required
coming
​boolean · required
​required
document
​LegalDocument · enum · required

The six legal documents the platform keeps (rule 1). Each value is also the last segment of the document's address, so it is spelled as a URL is.

Enum values:
terms
privacy
cookies
acceptable-use
processing-agreement
subprocessors
effective_at
​string · date-time · required
​object · required
in_force
​boolean · required
languages
​LegalLanguage[] · required
Enum values:
es
en
material
​boolean · required
name
​string · required
​required
published_at
​string · date-time · required
GET/api/v1/legal/documents/{document}/versions
curl /api/v1/legal/documents/:document/versions
Example Responses
[ { "address": "address", "coming": true, "deadline_at": "2024-08-25T15:00:00Z", "document": "terms", "effective_at": "2024-08-25T15:00:00Z", "fingerprints": { "key": "string" }, "in_force": true, "languages": [ "es" ], "material": true, "name": "name", "objection_ends_at": "2024-08-25T15:00:00Z", "published_at": "2024-08-25T15:00:00Z" } ]
json
application/json

Read Legal Version

GET
/api/v1/legal/documents/{document}/versions/{name}

Read one published version of a legal document as it was published, in language where it is written in it and in Spanish otherwise. Changes nothing.

Read Legal Version › path Parameters

document
​LegalDocument · enum · required

The six legal documents the platform keeps (rule 1). Each value is also the last segment of the document's address, so it is spelled as a URL is.

Enum values:
terms
privacy
cookies
acceptable-use
processing-agreement
subprocessors
name
​string · required

Read Legal Version › query Parameters

language
​LegalLanguage · enum

The languages a version may be written in (values table): Spanish required, English optional, and the Spanish prevails (rule 4).

Enum values:
es
en
Default: es

Read Legal Version › Responses

Successful Response

A version's text in the language asked, or in Spanish where it has none, and which one it is (rule 8).
VersionTextOut
address
​string · required
coming
​boolean · required
​required
document
​LegalDocument · enum · required

The six legal documents the platform keeps (rule 1). Each value is also the last segment of the document's address, so it is spelled as a URL is.

Enum values:
terms
privacy
cookies
acceptable-use
processing-agreement
subprocessors
effective_at
​string · date-time · required
fell_back
​boolean · required
fingerprint
​string · required
​object · required
in_force
​boolean · required
language
​LegalLanguage · enum · required

The languages a version may be written in (values table): Spanish required, English optional, and the Spanish prevails (rule 4).

Enum values:
es
en
languages
​LegalLanguage[] · required
Enum values:
es
en
material
​boolean · required
name
​string · required
​required
published_at
​string · date-time · required
text
​string · required
GET/api/v1/legal/documents/{document}/versions/{name}
curl /api/v1/legal/documents/:document/versions/:name
Example Responses
{ "address": "address", "coming": true, "deadline_at": "2024-08-25T15:00:00Z", "document": "terms", "effective_at": "2024-08-25T15:00:00Z", "fell_back": true, "fingerprint": "fingerprint", "fingerprints": { "key": "string" }, "in_force": true, "language": "es", "languages": [ "es" ], "material": true, "name": "name", "objection_ends_at": "2024-08-25T15:00:00Z", "published_at": "2024-08-25T15:00:00Z", "text": "text" }
json
application/json

Download Legal Version

GET
/api/v1/legal/documents/{document}/versions/{name}/download

Download the exact text of a version, headed by its name and fingerprint. Changes nothing.

Download Legal Version › path Parameters

document
​LegalDocument · enum · required

The six legal documents the platform keeps (rule 1). Each value is also the last segment of the document's address, so it is spelled as a URL is.

Enum values:
terms
privacy
cookies
acceptable-use
processing-agreement
subprocessors
name
​string · required

Download Legal Version › query Parameters

language
​LegalLanguage · enum

The languages a version may be written in (values table): Spanish required, English optional, and the Spanish prevails (rule 4).

Enum values:
es
en
Default: es

Download Legal Version › Responses

Successful Response

string
GET/api/v1/legal/documents/{document}/versions/{name}/download
curl /api/v1/legal/documents/:document/versions/:name/download
Example Responses
string
text
text/plain

Organization Legal History

GET
/api/v1/legal/history

Read your organization's whole history of agreements to the data processing agreement, objections and marks, newest first. Owners only. Changes nothing.

Organization Legal History › Responses

200

Successful Response

​LegalRecordOut[]
One entry of the proof, as its organization's owners and its person read it (rules 26, 28). Never changed once written.
LegalRecordOut
​required
id
​string · uuid · required
kind
​RecordKind · enum · required

What one entry of the proof records.

Enum values:
person_agreement
organization_agreement
objection
objection_withdrawn
own_agreement_marked
own_agreement_unmarked
​required
​required
​required
​required
​required
origin
​Origin · enum · required

Where an entry came from (rule 26): the dashboard or a key -- and, for a mark, staff from the directory (rule 23). before_legal is an agreement kept before this proof existed, carried over with what was kept then.

Enum values:
dashboard
key
staff
before_legal
​required
​required
​required
person_name
​string · required
​required
recorded_at
​string · date-time · required
​required
​required
​required
​AgreedVersionOut[] · required
​required
GET/api/v1/legal/history
curl /api/v1/legal/history \ --header 'Authorization: Bearer <token>'
Example Responses
[ { "api_key_id": "00000000-0000-0000-0000-000000000000", "id": "00000000-0000-0000-0000-000000000000", "kind": "person_agreement", "language": "es", "network_address": "string", "objection_id": "00000000-0000-0000-0000-000000000000", "org_id": "00000000-0000-0000-0000-000000000000", "org_name": "string", "origin": "dashboard", "own_agreement": "string", "person_email": "string", "person_id": "00000000-0000-0000-0000-000000000000", "person_name": "person_name", "reason": "string", "recorded_at": "2024-08-25T15:00:00Z", "role": "owner", "subprocessors": [ "string" ], "user_agent": "string", "versions": [ { "document": "terms", "fingerprint": "fingerprint", "language": "es", "name": "name" } ], "words": "string" } ]
json
application/json

Own Legal History

GET
/api/v1/legal/me/history

Read every agreement and objection you made, newest first. Changes nothing.

Own Legal History › Responses

200

Successful Response

​LegalRecordOut[]
One entry of the proof, as its organization's owners and its person read it (rules 26, 28). Never changed once written.
LegalRecordOut
​required
id
​string · uuid · required
kind
​RecordKind · enum · required

What one entry of the proof records.

Enum values:
person_agreement
organization_agreement
objection
objection_withdrawn
own_agreement_marked
own_agreement_unmarked
​required
​required
​required
​required
​required
origin
​Origin · enum · required

Where an entry came from (rule 26): the dashboard or a key -- and, for a mark, staff from the directory (rule 23). before_legal is an agreement kept before this proof existed, carried over with what was kept then.

Enum values:
dashboard
key
staff
before_legal
​required
​required
​required
person_name
​string · required
​required
recorded_at
​string · date-time · required
​required
​required
​required
​AgreedVersionOut[] · required
​required
GET/api/v1/legal/me/history
curl /api/v1/legal/me/history \ --header 'Authorization: Bearer <token>'
Example Responses
[ { "api_key_id": "00000000-0000-0000-0000-000000000000", "id": "00000000-0000-0000-0000-000000000000", "kind": "person_agreement", "language": "es", "network_address": "string", "objection_id": "00000000-0000-0000-0000-000000000000", "org_id": "00000000-0000-0000-0000-000000000000", "org_name": "string", "origin": "dashboard", "own_agreement": "string", "person_email": "string", "person_id": "00000000-0000-0000-0000-000000000000", "person_name": "person_name", "reason": "string", "recorded_at": "2024-08-25T15:00:00Z", "role": "owner", "subprocessors": [ "string" ], "user_agent": "string", "versions": [ { "document": "terms", "fingerprint": "fingerprint", "language": "es", "name": "name" } ], "words": "string" } ]
json
application/json

Object To Subprocessors

POST
/api/v1/legal/objections

Object, as an owner, to subprocessors of a version of the list during its period to object, saying which and why. Changes nothing that runs.

Object To Subprocessors › Request Body

`POST /legal/objections`: an owner objects to a version of the list of subprocessors during its period, saying which and why (rule 24).
ObjectionIn
language
​LegalLanguage · enum · required

The languages a version may be written in (values table): Spanish required, English optional, and the Spanish prevails (rule 4).

Enum values:
es
en
reason
​string · minLength: 1 · maxLength: 5000 · required
subprocessors
​string[] · minItems: 1 · required
version
​string · required

Object To Subprocessors › Responses

Successful Response

One entry of the proof, as its organization's owners and its person read it (rules 26, 28). Never changed once written.
LegalRecordOut
​required
id
​string · uuid · required
kind
​RecordKind · enum · required

What one entry of the proof records.

Enum values:
person_agreement
organization_agreement
objection
objection_withdrawn
own_agreement_marked
own_agreement_unmarked
​required
​required
​required
​required
​required
origin
​Origin · enum · required

Where an entry came from (rule 26): the dashboard or a key -- and, for a mark, staff from the directory (rule 23). before_legal is an agreement kept before this proof existed, carried over with what was kept then.

Enum values:
dashboard
key
staff
before_legal
​required
​required
​required
person_name
​string · required
​required
recorded_at
​string · date-time · required
​required
​required
​required
​AgreedVersionOut[] · required
​required
POST/api/v1/legal/objections
curl /api/v1/legal/objections \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "language": "es", "reason": "reason", "subprocessors": [ "string" ], "version": "version" }'
Example Request Body
{ "language": "es", "reason": "reason", "subprocessors": [ "string" ], "version": "version" }
json
Example Responses
{ "api_key_id": "00000000-0000-0000-0000-000000000000", "id": "00000000-0000-0000-0000-000000000000", "kind": "person_agreement", "language": "es", "network_address": "string", "objection_id": "00000000-0000-0000-0000-000000000000", "org_id": "00000000-0000-0000-0000-000000000000", "org_name": "string", "origin": "dashboard", "own_agreement": "string", "person_email": "string", "person_id": "00000000-0000-0000-0000-000000000000", "person_name": "person_name", "reason": "string", "recorded_at": "2024-08-25T15:00:00Z", "role": "owner", "subprocessors": [ "string" ], "user_agent": "string", "versions": [ { "document": "terms", "fingerprint": "fingerprint", "language": "es", "name": "name" } ], "words": "string" }
json
application/json

Withdraw Objection

POST
/api/v1/legal/objections/{objection_id}/withdraw

Withdraw an objection of your organization, as an owner; the withdrawal is kept beside it.

Withdraw Objection › path Parameters

objection_id
​string · uuid · required

Withdraw Objection › Request Body

`POST /legal/objections/{id}/withdraw` (rule 25).
WithdrawalIn
language
​LegalLanguage · enum · required

The languages a version may be written in (values table): Spanish required, English optional, and the Spanish prevails (rule 4).

Enum values:
es
en

Withdraw Objection › Responses

Successful Response

One entry of the proof, as its organization's owners and its person read it (rules 26, 28). Never changed once written.
LegalRecordOut
​required
id
​string · uuid · required
kind
​RecordKind · enum · required

What one entry of the proof records.

Enum values:
person_agreement
organization_agreement
objection
objection_withdrawn
own_agreement_marked
own_agreement_unmarked
​required
​required
​required
​required
​required
origin
​Origin · enum · required

Where an entry came from (rule 26): the dashboard or a key -- and, for a mark, staff from the directory (rule 23). before_legal is an agreement kept before this proof existed, carried over with what was kept then.

Enum values:
dashboard
key
staff
before_legal
​required
​required
​required
person_name
​string · required
​required
recorded_at
​string · date-time · required
​required
​required
​required
​AgreedVersionOut[] · required
​required
POST/api/v1/legal/objections/{objection_id}/withdraw
curl /api/v1/legal/objections/:objection_id/withdraw \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "language": "es" }'
Example Request Body
{ "language": "es" }
json
Example Responses
{ "api_key_id": "00000000-0000-0000-0000-000000000000", "id": "00000000-0000-0000-0000-000000000000", "kind": "person_agreement", "language": "es", "network_address": "string", "objection_id": "00000000-0000-0000-0000-000000000000", "org_id": "00000000-0000-0000-0000-000000000000", "org_name": "string", "origin": "dashboard", "own_agreement": "string", "person_email": "string", "person_id": "00000000-0000-0000-0000-000000000000", "person_name": "person_name", "reason": "string", "recorded_at": "2024-08-25T15:00:00Z", "role": "owner", "subprocessors": [ "string" ], "user_agent": "string", "versions": [ { "document": "terms", "fingerprint": "fingerprint", "language": "es", "name": "name" } ], "words": "string" }
json
application/json

Legal Pending

GET
/api/v1/legal/pending

What the platform asks of you and your organization now: Terms or Privacy versions to agree to again, the data processing agreement and whether the organization is held, and lists of subprocessors still open to objection. Changes nothing.

Legal Pending › Responses

200

Successful Response

`GET /legal/pending`: what the platform asks of this person and their organization now.
PendingOut
​ObjectionPeriodOut[] · required
​required
​PersonAskOut[] · required
GET/api/v1/legal/pending
curl /api/v1/legal/pending \ --header 'Authorization: Bearer <token>'
Example Responses
{ "objection_periods": [ { "ends_at": "2024-08-25T15:00:00Z", "version": "version" } ], "organization": { "deadline_at": "2024-08-25T15:00:00Z", "held": true, "may_agree": true, "version": "version" }, "person": [ { "blocking": true, "deadline_at": "2024-08-25T15:00:00Z", "document": "terms", "version": "version" } ] }
json
application/json

interactionsnot-a-tool