Data schemaField definitionsFriendly Names

Retrieve friendly names

View as Markdown
Retrieve a list of friendly names.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional>=1Defaults to 1
Page number for pagination.
sizeintegerOptional1-100Defaults to 10
Number of items to retrieve per page.
stakeholder_idstringOptional
ID of stakeholder of the friendly names to be retrieved.
language_codeenumOptional
Language code of the friendly names to be retrieved.
Allowed values:

Response

List of friendly names.
datalist of objects
paginationobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error