Workspace_fonts

>>>

GET /api/v4/workspaces/fonts
List of users fonts

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  fonts: [
    {
      "id": 385,
      "customer_name": "font",
      "system_name": "font",
      "link": "link"
    },
    ...
  ],
  meta: {
    "total_count": 3
  }
}

Params

Param name Description
sort_to
optional

Sort fonts by customer_name

Validations:

  • Must be one of: asc, desc.
page
optional

Validations:

  • Must be a Integer
per_page
optional

Validations:

  • Must be a Integer
>>>

POST /api/v4/workspaces/fonts
Create font

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "font": {
    "customer_name": "font",
    "system_name": "font",
    "link": "link"
  }
}

Success response body ↑

{
  "id": 385,
  "customer_name": "font",
  "system_name": "font",
  "link": "link"
}

Params

Param name Description
font
required

Validations:

  • Must be a Hash
font[customer_name]
required

Name of font

Validations:

  • Must be a String
font[system_name]
required

System name of font

Validations:

  • Must be a String
font[link]
required

Link to font

Validations:

  • Must be a String
>>>

PUT /api/v4/workspaces/fonts/:id
Update font

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "font": {
    "customer_name": "updated font",
    "system_name": "updated font",
    "link": "updated link"
  }
}

Success response body ↑

{
  "id": 385,
  "customer_name": "updated font",
  "system_name": "updated font",
  "link": "updated link"
}

Params

Param name Description
id
required

Font ID

Validations:

  • Must be a String
font
required

Validations:

  • Must be a Hash
font[customer_name]
required

Name of font

Validations:

  • Must be a String
font[system_name]
required

System name of font

Validations:

  • Must be a String
font[link]
required

Link to font

Validations:

  • Must be a String
>>>

DELETE /api/v4/workspaces/fonts/:id
Delete font

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  success: true
}

Params

Param name Description
id
required

Font ID

Validations:

  • Must be a String