Terminology
Find terms
Terminology
Find terms
GET
/
terminology
/
organization
/
{organizationId}
/
team
/
{teamId}
curl --request GET \
--url https://enterprise-api.writer.com/terminology/organization/{organizationId}/team/{teamId} \
--header 'Authorization: <authorization>'
{
"result": [
{
"id": 123,
"termBankId": 123,
"term": "<string>",
"type": "approved",
"pos": "noun",
"caseSensitive": true,
"description": "<string>",
"highlight": true,
"creationTime": "2023-11-07T05:31:56Z",
"modificationTime": "2023-11-07T05:31:56Z",
"createdUser": {
"id": 123,
"fullName": "<string>",
"email": "<string>"
},
"modifiedUser": {
"id": 123,
"fullName": "<string>",
"email": "<string>"
},
"examples": [
{
"id": 123,
"termId": 123,
"termBankId": 123,
"example": "<string>",
"type": "good"
}
],
"mistakes": [
{
"id": 123,
"termId": 123,
"termBankId": 123,
"mistake": "<string>",
"pos": "noun",
"caseSensitive": true
}
],
"tags": [
{
"id": 123,
"tag": "<string>",
"termId": 123,
"parentTagId": 123
}
],
"linkedTerms": [
{
"id": 123,
"termId": 123,
"linkedTermId": 123,
"term": "<string>",
"pos": "noun",
"caseSensitive": true,
"approvedTermExtension": {
"id": 123,
"termId": 123,
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"backlinkedTerms": [
{
"id": 123,
"termId": 123,
"linkedTermId": 123,
"term": "<string>",
"pos": "noun",
"caseSensitive": true,
"approvedTermExtension": {
"id": 123,
"termId": 123,
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"approvedTermExtension": {
"id": 123,
"termId": 123,
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"totalCount": 123,
"pagination": {
"offset": 123,
"limit": 123
}
}
We’re deprecating these API endpoints, so the AI Studio API key setup won’t work. [Contact support] (https://support.writer.com/) if you need them.
Headers
Authorization
string
requiredPath Parameters
organizationId
integer
requiredteamId
integer
requiredQuery Parameters
type
enum<string>
Available options:
approved
, banned
, pending
term
string
partOfSpeech
enum<string>
Available options:
noun
, verb
, adverb
, adjective
tags
string[]
sortField
enum<string>
Available options:
term
, creationTime
, modificationTime
, type
sortOrder
enum<string>
Available options:
asc
, desc
offset
integer
limit
integer
Response
200 - application/json
result
object[]
result.id
integer
requiredresult.termBankId
integer
requiredresult.term
string
requiredresult.type
enum<string>
requiredAvailable options:
approved
, banned
, pending
result.pos
enum<string>
Available options:
noun
, verb
, adverb
, adjective
result.caseSensitive
boolean
requiredresult.description
string
result.highlight
boolean
requiredresult.creationTime
string
requiredresult.modificationTime
string
requiredresult.createdUser
object
requiredresult.createdUser.id
integer
requiredresult.createdUser.fullName
string
result.createdUser.email
string
result.modifiedUser
object
requiredresult.modifiedUser.id
integer
requiredresult.modifiedUser.fullName
string
result.modifiedUser.email
string
result.examples
object[]
result.examples.id
integer
result.examples.termId
integer
requiredresult.examples.termBankId
integer
requiredresult.examples.example
string
requiredresult.examples.type
enum<string>
requiredAvailable options:
good
, bad
result.mistakes
object[]
result.mistakes.id
integer
result.mistakes.termId
integer
requiredresult.mistakes.termBankId
integer
requiredresult.mistakes.mistake
string
requiredresult.mistakes.pos
enum<string>
Available options:
noun
, verb
, adverb
, adjective
result.mistakes.caseSensitive
boolean
requiredresult.tags
object[]
result.tags.id
integer
requiredresult.tags.tag
string
requiredresult.tags.termId
integer
requiredresult.tags.parentTagId
integer
requiredresult.linkedTerms
object[]
result.linkedTerms.id
integer
result.linkedTerms.termId
integer
requiredresult.linkedTerms.linkedTermId
integer
requiredresult.linkedTerms.term
string
requiredresult.linkedTerms.pos
enum<string>
Available options:
noun
, verb
, adverb
, adjective
result.linkedTerms.caseSensitive
boolean
requiredresult.linkedTerms.approvedTermExtension
object
result.linkedTerms.approvedTermExtension.id
integer
result.linkedTerms.approvedTermExtension.termId
integer
requiredresult.linkedTerms.approvedTermExtension.capitalize
boolean
requiredresult.linkedTerms.approvedTermExtension.fixCommonMistakes
boolean
requiredresult.linkedTerms.approvedTermExtension.fixCase
boolean
requiredresult.backlinkedTerms
object[]
result.backlinkedTerms.id
integer
result.backlinkedTerms.termId
integer
requiredresult.backlinkedTerms.linkedTermId
integer
requiredresult.backlinkedTerms.term
string
requiredresult.backlinkedTerms.pos
enum<string>
Available options:
noun
, verb
, adverb
, adjective
result.backlinkedTerms.caseSensitive
boolean
requiredresult.backlinkedTerms.approvedTermExtension
object
result.backlinkedTerms.approvedTermExtension.id
integer
result.backlinkedTerms.approvedTermExtension.termId
integer
requiredresult.backlinkedTerms.approvedTermExtension.capitalize
boolean
requiredresult.backlinkedTerms.approvedTermExtension.fixCommonMistakes
boolean
requiredresult.backlinkedTerms.approvedTermExtension.fixCase
boolean
requiredresult.approvedTermExtension
object
result.approvedTermExtension.id
integer
result.approvedTermExtension.termId
integer
requiredresult.approvedTermExtension.capitalize
boolean
requiredresult.approvedTermExtension.fixCommonMistakes
boolean
requiredresult.approvedTermExtension.fixCase
boolean
requiredtotalCount
integer
requiredpagination
object
requiredpagination.offset
integer
pagination.limit
integer
curl --request GET \
--url https://enterprise-api.writer.com/terminology/organization/{organizationId}/team/{teamId} \
--header 'Authorization: <authorization>'
{
"result": [
{
"id": 123,
"termBankId": 123,
"term": "<string>",
"type": "approved",
"pos": "noun",
"caseSensitive": true,
"description": "<string>",
"highlight": true,
"creationTime": "2023-11-07T05:31:56Z",
"modificationTime": "2023-11-07T05:31:56Z",
"createdUser": {
"id": 123,
"fullName": "<string>",
"email": "<string>"
},
"modifiedUser": {
"id": 123,
"fullName": "<string>",
"email": "<string>"
},
"examples": [
{
"id": 123,
"termId": 123,
"termBankId": 123,
"example": "<string>",
"type": "good"
}
],
"mistakes": [
{
"id": 123,
"termId": 123,
"termBankId": 123,
"mistake": "<string>",
"pos": "noun",
"caseSensitive": true
}
],
"tags": [
{
"id": 123,
"tag": "<string>",
"termId": 123,
"parentTagId": 123
}
],
"linkedTerms": [
{
"id": 123,
"termId": 123,
"linkedTermId": 123,
"term": "<string>",
"pos": "noun",
"caseSensitive": true,
"approvedTermExtension": {
"id": 123,
"termId": 123,
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"backlinkedTerms": [
{
"id": 123,
"termId": 123,
"linkedTermId": 123,
"term": "<string>",
"pos": "noun",
"caseSensitive": true,
"approvedTermExtension": {
"id": 123,
"termId": 123,
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"approvedTermExtension": {
"id": 123,
"termId": 123,
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"totalCount": 123,
"pagination": {
"offset": 123,
"limit": 123
}
}