Nuvelics documentation
APIAPI reference

Custom fonts

Add your organization's own font files for its brand kits to use as typefaces, then list, rename, replace or delete them.

List the organization's custom fonts

GET
/api/tenant/v1/custom-fonts

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Query Parameters

family.contains?string

Narrow the list to fonts whose family name contains this text, ignoring case

family.eq?string

Narrow the list to the font whose family name is this, ignoring case

family.in?|array<string>

Narrow the list to fonts whose family name is any of these (repeat the key)

Response Body

The org's custom fonts, narrowed by any filters supplied

application/json
  1. response
items*array<>
Example Request
curl -X GET 'https://api.nuvelics.com/api/tenant/v1/custom-fonts'
Example Response
{  "items": [    {      "id": "string",      "orgId": "string",      "family": "string",      "assetId": "string",      "rightsAcknowledgedBy": "string",      "rightsAcknowledgedAt": "2019-08-24T14:15:22Z",      "createdBy": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedBy": "string",      "updatedAt": "2019-08-24T14:15:22Z",      "url": "string",      "contentType": "string",      "sizeBytes": 0,      "createdByName": "string",      "updatedByName": "string",      "rightsAcknowledgedByName": "string",      "usedBy": [        {          "id": "string",          "name": "string"        }      ]    }  ]}

Add a custom font

POST
/api/tenant/v1/custom-fonts

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Request Body

application/json
  1. body
assetId*string

A completed brand_font upload of the org that no other custom font holds

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
family*string

Family name the org gives the face; unique within the org, ignoring case

Length1 <= length <= 120
rightsAcknowledged*true
Value intrue

Response Body

Custom font added

application/json
  1. response
id*string

Custom font identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
orgId*string
family*string

Family name the org gives the face; unique within the org, ignoring case

Length1 <= length <= 120
assetId*string

The font file, a brand_font asset

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
rightsAcknowledgedBy*string

User who asserted the org holds a licence to embed the current file

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
rightsAcknowledgedAt*string

When the licence was asserted for the current file

Formatdate-time
createdBy*string

User identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
createdAt*string
Formatdate-time
updatedBy*string

User identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
updatedAt*string
Formatdate-time
url*string

Short-lived signed GET for the font file

contentType*string

The file's content type, such as font/woff2

sizeBytes*integer
Range0 <= value
createdByName*string

Display name (else email) of the user who added this font; null when no user did, the user id when the user cannot be read

updatedByName*string

Display name (else email) of the user who last changed this font; null when no user did, the user id when the user cannot be read

rightsAcknowledgedByName*string

Display name (else email) of the user who asserted the licence for the current file; null when no user did, the user id when the user cannot be read

usedBy*array<>

Brand kits naming this font as their display or body face

Example Request
curl -X POST 'https://api.nuvelics.com/api/tenant/v1/custom-fonts' \  -H 'Content-Type: application/json' \  -d '{  "assetId": "string",  "family": "string",  "rightsAcknowledged": true}'
Example Response
{  "id": "string",  "orgId": "string",  "family": "string",  "assetId": "string",  "rightsAcknowledgedBy": "string",  "rightsAcknowledgedAt": "2019-08-24T14:15:22Z",  "createdBy": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedBy": "string",  "updatedAt": "2019-08-24T14:15:22Z",  "url": "string",  "contentType": "string",  "sizeBytes": 0,  "createdByName": "string",  "updatedByName": "string",  "rightsAcknowledgedByName": "string",  "usedBy": [    {      "id": "string",      "name": "string"    }  ]}

Get a custom font

GET
/api/tenant/v1/custom-fonts/{id}

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Path Parameters

id*string

Custom font identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

The custom font

application/json
  1. response
id*string

Custom font identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
orgId*string
family*string

Family name the org gives the face; unique within the org, ignoring case

Length1 <= length <= 120
assetId*string

The font file, a brand_font asset

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
rightsAcknowledgedBy*string

User who asserted the org holds a licence to embed the current file

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
rightsAcknowledgedAt*string

When the licence was asserted for the current file

Formatdate-time
createdBy*string

User identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
createdAt*string
Formatdate-time
updatedBy*string

User identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
updatedAt*string
Formatdate-time
url*string

Short-lived signed GET for the font file

contentType*string

The file's content type, such as font/woff2

sizeBytes*integer
Range0 <= value
createdByName*string

Display name (else email) of the user who added this font; null when no user did, the user id when the user cannot be read

updatedByName*string

Display name (else email) of the user who last changed this font; null when no user did, the user id when the user cannot be read

rightsAcknowledgedByName*string

Display name (else email) of the user who asserted the licence for the current file; null when no user did, the user id when the user cannot be read

usedBy*array<>

Brand kits naming this font as their display or body face

Example Request
curl -X GET 'https://api.nuvelics.com/api/tenant/v1/custom-fonts/string'
Example Response
{  "id": "string",  "orgId": "string",  "family": "string",  "assetId": "string",  "rightsAcknowledgedBy": "string",  "rightsAcknowledgedAt": "2019-08-24T14:15:22Z",  "createdBy": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedBy": "string",  "updatedAt": "2019-08-24T14:15:22Z",  "url": "string",  "contentType": "string",  "sizeBytes": 0,  "createdByName": "string",  "updatedByName": "string",  "rightsAcknowledgedByName": "string",  "usedBy": [    {      "id": "string",      "name": "string"    }  ]}

Rename a custom font or replace its file

PATCH
/api/tenant/v1/custom-fonts/{id}

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Path Parameters

id*string

Custom font identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Request Body

application/json
  1. body
family?string

Family name the org gives the face; unique within the org, ignoring case

Length1 <= length <= 120
assetId?string

A replacement file; requires rightsAcknowledged

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
rightsAcknowledged?true
Value intrue

Response Body

Custom font updated

application/json
  1. response
id*string

Custom font identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
orgId*string
family*string

Family name the org gives the face; unique within the org, ignoring case

Length1 <= length <= 120
assetId*string

The font file, a brand_font asset

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
rightsAcknowledgedBy*string

User who asserted the org holds a licence to embed the current file

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
rightsAcknowledgedAt*string

When the licence was asserted for the current file

Formatdate-time
createdBy*string

User identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
createdAt*string
Formatdate-time
updatedBy*string

User identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
updatedAt*string
Formatdate-time
url*string

Short-lived signed GET for the font file

contentType*string

The file's content type, such as font/woff2

sizeBytes*integer
Range0 <= value
createdByName*string

Display name (else email) of the user who added this font; null when no user did, the user id when the user cannot be read

updatedByName*string

Display name (else email) of the user who last changed this font; null when no user did, the user id when the user cannot be read

rightsAcknowledgedByName*string

Display name (else email) of the user who asserted the licence for the current file; null when no user did, the user id when the user cannot be read

usedBy*array<>

Brand kits naming this font as their display or body face

Example Request
curl -X PATCH 'https://api.nuvelics.com/api/tenant/v1/custom-fonts/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "orgId": "string",  "family": "string",  "assetId": "string",  "rightsAcknowledgedBy": "string",  "rightsAcknowledgedAt": "2019-08-24T14:15:22Z",  "createdBy": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedBy": "string",  "updatedAt": "2019-08-24T14:15:22Z",  "url": "string",  "contentType": "string",  "sizeBytes": 0,  "createdByName": "string",  "updatedByName": "string",  "rightsAcknowledgedByName": "string",  "usedBy": [    {      "id": "string",      "name": "string"    }  ]}

Delete a custom font and its file

DELETE
/api/tenant/v1/custom-fonts/{id}

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Path Parameters

id*string

Custom font identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

Custom font deleted

Example Request
curl -X DELETE 'https://api.nuvelics.com/api/tenant/v1/custom-fonts/string'
Example Response
Empty

Report a problem with this page

Credentials

Store the secrets your data sources and connections sign in with, and list the options a data source's vendor offers.

Dashboard

Read everything your organization's dashboard shows in one call: top pitches, the pitch backlog, story activity, data source health and what needs attention.

On this page

List the organization's custom fontsAdd a custom fontGet a custom fontRename a custom font or replace its fileDelete a custom font and its file